Skip to content

Commit

Permalink
Merge pull request #1 from jtaubensee/service_bus_doc_updates
Browse files Browse the repository at this point in the history
updating the Service Bus PowerShell documentation
  • Loading branch information
Ajit Navasare authored Feb 2, 2017
2 parents 6fd5233 + 1ddca5c commit e5bc928
Show file tree
Hide file tree
Showing 34 changed files with 277 additions and 290 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ schema: 2.0.0
# Get-AzureRmServiceBusNamespace

## SYNOPSIS
Gets a description for the specified ServiceBus namespace within the ResourceGroup
Gets a description for the specified Service Bus namespace within the resource group.

## SYNTAX

Expand All @@ -16,7 +16,7 @@ Get-AzureRmServiceBusNamespace [[-ResourceGroup] <String>] [[-NamespaceName] <St
```

## DESCRIPTION
The ** Get-AzureRmServiceBusNamespace ** cmdlet gets a description for the specified ServiceBus namespace within the ResourceGroup
The **Get-AzureRmServiceBusNamespace** cmdlet gets a description for the specified Service Bus namespace within the resource group.

## EXAMPLES

Expand All @@ -25,12 +25,12 @@ The ** Get-AzureRmServiceBusNamespace ** cmdlet gets a description for the speci
PS C:\> Get-AzureRmServiceBusNamespace -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1
```

Returns the Description of the specified ServiceBus Namespace
Returns a description of the specified Service Bus namespace.

## PARAMETERS

### -NamespaceName
Namespace Name.
Namespace name.

```yaml
Type: String
Expand All @@ -45,7 +45,7 @@ Accept wildcard characters: False
```
### -ResourceGroup
The name of the resource group
The name of the resource group.
```yaml
Type: String
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ schema: 2.0.0
# Get-AzureRmServiceBusNamespaceAuthorizationRule

## SYNOPSIS
Gets the Description of a specified AuthorizationRule for a given namespace.
Gets a description of the specified authorization rule for a given namespace.

## SYNTAX

Expand All @@ -17,7 +17,7 @@ Get-AzureRmServiceBusNamespaceAuthorizationRule [-ResourceGroup] <String> [-Name
```

## DESCRIPTION
The ** Get-AzureRmServiceBusNamespaceAuthorizationRule ** cmdlet gets the description of specified authorizationrule of the given namespace.
The **Get-AzureRmServiceBusNamespaceAuthorizationRule** cmdlet gets the description of the specified authorization rule in the given namespace.

## EXAMPLES

Expand All @@ -26,12 +26,12 @@ The ** Get-AzureRmServiceBusNamespaceAuthorizationRule ** cmdlet gets the descri
PS C:\> Get-AzureRmServiceBusNamespaceAuthorizationRule -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -AuthorizationRuleName AuthoRule1
```

Returns the specified AuthorizationRule description for a given namespace.
Returns the specified authorization rule description for a specified namespace.

## PARAMETERS

### -AuthorizationRuleName
ServiceBus Namespace AuthorizationRule Name.
The Service Bus namespace authorization rule name.

```yaml
Type: String
Expand All @@ -46,7 +46,7 @@ Accept wildcard characters: False
```
### -NamespaceName
ServiceBus Namespace Name.
The Service Bus namespace name.
```yaml
Type: String
Expand All @@ -61,7 +61,7 @@ Accept wildcard characters: False
```
### -ResourceGroup
The name of the resource group
The name of the resource group.
```yaml
Type: String
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Get-AzureRmServiceBusNamespaceKey [-ResourceGroup] <String> [-NamespaceName] <St
```

## DESCRIPTION
The ** Get-AzureRmServiceBusNamespaceKey ** cmdlet returns the primary and secondary connection strings for the given namespace.
The **Get-AzureRmServiceBusNamespaceKey** cmdlet returns the primary and secondary connection strings for the given namespace.

## EXAMPLES

Expand All @@ -26,12 +26,12 @@ The ** Get-AzureRmServiceBusNamespaceKey ** cmdlet returns the primary and secon
PS C:\> Get-AzureRmServiceBusNamespaceKey -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -AuthorizationRuleName AuthoRule1
```

Primary and Secondary Connection string to the given namespace
Primary and secondary connection string to the specified namespace.

## PARAMETERS

### -AuthorizationRuleName
ServiceBus Namespace AuthorizationRule Name.
Service Bus namespace authorization rule name.

```yaml
Type: String
Expand All @@ -46,7 +46,7 @@ Accept wildcard characters: False
```
### -NamespaceName
ServiceBus Namespace Name.
Service Bus namespace name.
```yaml
Type: String
Expand All @@ -61,7 +61,7 @@ Accept wildcard characters: False
```
### -ResourceGroup
The name of the resource group
The name of the resource group.
```yaml
Type: String
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ schema: 2.0.0
# Get-AzureRmServiceBusQueue

## SYNOPSIS
Returns a description for the specified queue.
Returns a description for the specified Service Bus queue.

## SYNTAX

Expand All @@ -17,7 +17,7 @@ Get-AzureRmServiceBusQueue [-ResourceGroup] <String> [-NamespaceName] <String> [
```

## DESCRIPTION
The ** Get-AzureRmServiceBusQueue ** cmdlet returns description pf the specified ServiceBus Queue
The **Get-AzureRmServiceBusQueue** cmdlet returns a description of the specified Service Bus queue.

## EXAMPLES

Expand All @@ -26,12 +26,12 @@ The ** Get-AzureRmServiceBusQueue ** cmdlet returns description pf the specified
PS C:\> Get-AzureRmServiceBusQueue -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -QueueName SB-Queue_example1
```

Returns the
Returns the description of the queue.

## PARAMETERS

### -NamespaceName
Namespace Name.
The Service Bus namespace name.

```yaml
Type: String
Expand All @@ -46,7 +46,7 @@ Accept wildcard characters: False
```
### -QueueName
Queue Name.
The queue name.
```yaml
Type: String
Expand All @@ -61,7 +61,7 @@ Accept wildcard characters: False
```
### -ResourceGroup
The name of the resource group
The name of the resource group.
```yaml
Type: String
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ schema: 2.0.0
# Get-AzureRmServiceBusQueueAuthorizationRule

## SYNOPSIS
Gets the Description of a specified AuthorizationRule for a given ServiceBus Queue.
Gets the description of a specified authorization rule for a given Service Bus queue.

## SYNTAX

Expand All @@ -17,7 +17,7 @@ Get-AzureRmServiceBusQueueAuthorizationRule [-ResourceGroup] <String> [-Namespac
```

## DESCRIPTION
The ** Get-AzureRmServiceBusQueueAuthorizationRule ** cmdlet gets the description of specified authorizationrule of the given servicebus queue.
The **Get-AzureRmServiceBusQueueAuthorizationRule** cmdlet gets the description of a specified authorization rule on the given Service Bus queue.

## EXAMPLES

Expand All @@ -26,12 +26,12 @@ The ** Get-AzureRmServiceBusQueueAuthorizationRule ** cmdlet gets the descriptio
PS C:\> Get-AzureRmServiceBusQueueAuthorizationRule -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -QueueName SB-Queue_exampl1 -AuthorizationRuleName SBAuthoRule1
```

Returns the specified AuthorizationRule description for a given ServiceBus Queue.
Returns the specified authorization rule description for a given Service Bus queue.

## PARAMETERS

### -AuthorizationRuleName
EventHub AuthorizationRule Name.
The authorization rule name.

```yaml
Type: String
Expand All @@ -46,7 +46,7 @@ Accept wildcard characters: False
```
### -NamespaceName
Namespace Name.
The Service Bus namespace name.
```yaml
Type: String
Expand All @@ -61,7 +61,7 @@ Accept wildcard characters: False
```
### -QueueName
Queue Name.
The queue name.
```yaml
Type: String
Expand All @@ -76,7 +76,7 @@ Accept wildcard characters: False
```
### -ResourceGroup
The name of the resource group
The name of the resource group.
```yaml
Type: String
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ schema: 2.0.0
# Get-AzureRmServiceBusQueueKey

## SYNOPSIS
Gets the primary and secondary connection strings for the given ServiceBus Queue.
Gets the primary and secondary connection strings for the given Service Bus queue.

## SYNTAX

Expand All @@ -17,7 +17,7 @@ Get-AzureRmServiceBusQueueKey [-ResourceGroup] <String> [-NamespaceName] <String
```

## DESCRIPTION
The ** Get-AzureRmServiceBusQueueKey ** cmdlet returns the primary and secondary connection strings for the given servicebus queue.
The **Get-AzureRmServiceBusQueueKey** cmdlet returns the primary and secondary connection strings for the given Service Bus queue.

## EXAMPLES

Expand All @@ -26,12 +26,12 @@ The ** Get-AzureRmServiceBusQueueKey ** cmdlet returns the primary and secondary
PS C:\> Get-AzureRmServiceBusQueueKey -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -QueueName SB-Queue_exampl1 -AuthorizationRuleName SBAuthoRule1
```

primary and secondary connection strings are returned for the given ServiceBus Queue.
The primary and secondary connection strings are returned for the given Service Bus queue.

## PARAMETERS

### -AuthorizationRuleName
ServiceBus Queue AuthorizationRule Name.
The queue authorization rule name.

```yaml
Type: String
Expand All @@ -46,7 +46,7 @@ Accept wildcard characters: False
```
### -NamespaceName
ServiceBus Namespace Name.
The Service Bus namespace name.
```yaml
Type: String
Expand All @@ -61,7 +61,7 @@ Accept wildcard characters: False
```
### -QueueName
ServiceBus Queue Name.
The Service Bus queue name.
```yaml
Type: String
Expand All @@ -76,7 +76,7 @@ Accept wildcard characters: False
```
### -ResourceGroup
The name of the resource group
The name of the resource group.
```yaml
Type: String
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Get-AzureRmServiceBusSubscription [-ResourceGroup] <String> [-NamespaceName] <St
```

## DESCRIPTION
The ** Get-AzureRmServiceBusSubscription ** cmdlet returns a subscription description for the specified topic.
The **Get-AzureRmServiceBusSubscription** cmdlet returns a subscription description for the specified Service Bus topic.

## EXAMPLES

Expand All @@ -26,12 +26,12 @@ The ** Get-AzureRmServiceBusSubscription ** cmdlet returns a subscription descri
PS C:\> Get-AzureRmServiceBusSubscription -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -TopicName SB-Topic_exampl1 -SubscriptionName SB-TopicSubscription-Example1
```

Returns a subscription description for the specified servicebus Topic.
Returns a subscription description for the specified Service Bus Topic.

## PARAMETERS

### -NamespaceName
Namespace Name.
The Service Bus namespace name.

```yaml
Type: String
Expand All @@ -46,7 +46,7 @@ Accept wildcard characters: False
```
### -ResourceGroup
The name of the resource group
The name of the resource group.
```yaml
Type: String
Expand All @@ -61,7 +61,7 @@ Accept wildcard characters: False
```
### -SubscriptionName
Subscription Name.
The subscription name.
```yaml
Type: String
Expand All @@ -76,7 +76,7 @@ Accept wildcard characters: False
```
### -TopicName
Topic Name.
The topic name.
```yaml
Type: String
Expand Down
Loading

0 comments on commit e5bc928

Please sign in to comment.