Skip to content

Updates and clarifications to Service Bus PS docs, ported from azure-… #3482

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 9, 2017
Merged

Updates and clarifications to Service Bus PS docs, ported from azure-… #3482

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7c9c7e1
Updates and clarifications to Service Bus PS docs, ported from azure-…
sethmanheim Feb 8, 2017
e66fe8b
Ran update-markdownhelpmodule
sethmanheim Feb 8, 2017
3ba6e12
Updating help XML file as well
sethmanheim Feb 8, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 34 additions & 34 deletions ...ceManager/ServiceBus/Commands.ServiceBus/Microsoft.Azure.Commands.ServiceBus.dll-Help.xml
View file
Open in desktop

Large diffs are not rendered by default.

8 changes: 3 additions & 5 deletions ...ceManager/ServiceBus/Commands.ServiceBus/help/Get-AzureRmServiceBusNamespace.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Returns a description of the specified Service Bus namespace.
## PARAMETERS

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

```yaml
Type: String
Expand Down Expand Up @@ -64,16 +64,15 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## INPUTS

###-ResourceGroup
### -ResourceGroup
System.String

###-NamespaceName
### -NamespaceName
System.String

## OUTPUTS

### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.ServiceBus.Models.NamespaceAttributes, Microsoft.Azure.Commands.ServiceBus, Version=0.0.1.0, Culture=neutral, PublicKeyToken=null]]

Name : SB-Example1
Id : /subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.ServiceBus/namespaces/SB-Example1
Location : West US
Expand All @@ -85,7 +84,6 @@ UpdatedAt : 1/20/2017 1:40:24 AM
ServiceBusEndpoint : https://SB-Example1.servicebus.windows.net:443/
Enabled : True


## NOTES

## RELATED LINKS
Expand Down
10 changes: 5 additions & 5 deletions ...Bus/Commands.ServiceBus/help/Get-AzureRmServiceBusNamespaceAuthorizationRule.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,27 +80,27 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## INPUTS

###-ResourceGroup
### -ResourceGroup
System.String

###-NamespaceName

### -NamespaceName
System.String

###-AuthorizationRuleName

### -AuthorizationRuleName
System.String

## OUTPUTS

### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.ServiceBus.Models.SharedAccessAuthorizationRuleAttributes, Microsoft.Azure.Commands.ServiceBus, Version=0.0.1.0, Culture=neutral, PublicKeyToken=null]]

Id : /subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.ServiceBus/namespaces/SB-Example1/AuthorizationRules/AuthoRule1
Type : Microsoft.ServiceBus/AuthorizationRules
Name : AuthoRule1
Location :
Tags :
Rights : {Listen, Send}


## NOTES

## RELATED LINKS
Expand Down
11 changes: 6 additions & 5 deletions ...anager/ServiceBus/Commands.ServiceBus/help/Get-AzureRmServiceBusNamespaceKey.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Accept wildcard characters: False
```

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

```yaml
Type: String
Expand Down Expand Up @@ -80,19 +80,20 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## INPUTS

###-ResourceGroup
### -ResourceGroup
System.String

###-NamespaceName

### -NamespaceName
System.String

###-AuthorizationRuleName

### -AuthorizationRuleName
System.String

## OUTPUTS

### Microsoft.Azure.Management.ServiceBus.Models.ResourceListKeys

PrimaryConnectionString : Endpoint=sb://sb-example1.servicebus.windows.net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey={SharedAccessKey value}
SecondaryConnectionString : Endpoint=sb://sb-example1.servicebus.windows.net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey={SharedAccessKey value}
PrimaryKey : {PrimaryKey value}
Expand Down
8 changes: 5 additions & 3 deletions ...sourceManager/ServiceBus/Commands.ServiceBus/help/Get-AzureRmServiceBusQueue.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,13 +80,15 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## INPUTS

###-ResourceGroup
### -ResourceGroup
System.String

###-NamespaceName

### -NamespaceName
System.String

###-QueueName

### -QueueName
System.String

## OUTPUTS
Expand Down
13 changes: 7 additions & 6 deletions ...viceBus/Commands.ServiceBus/help/Get-AzureRmServiceBusQueueAuthorizationRule.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,22 +95,24 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## INPUTS

###-ResourceGroup
### -ResourceGroup
System.String

###-NamespaceName

### -NamespaceName
System.String

###-QueueName

### -QueueName
System.String

###-AuthorizationRuleName

### -AuthorizationRuleName
System.String

## OUTPUTS

### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.ServiceBus.Models.SharedAccessAuthorizationRuleAttributes, Microsoft.Azure.Commands.ServiceBus, Version=0.0.1.0, Culture=neutral, PublicKeyToken=null]]

Id : /subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.ServiceBus/namespaces/SB-Example1/queues/SB-Queue_exampl1/authorizati
onRules/SBAuthoRule1
Type : Microsoft.ServiceBus/AuthorizationRules
Expand All @@ -119,7 +121,6 @@ Location : West US
Tags :
Rights : {Listen, Send}


## NOTES

## RELATED LINKS
Expand Down
14 changes: 8 additions & 6 deletions ...rceManager/ServiceBus/Commands.ServiceBus/help/Get-AzureRmServiceBusQueueKey.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The **Get-AzureRmServiceBusQueueKey** cmdlet returns the primary and secondary c
PS C:\> Get-AzureRmServiceBusQueueKey -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -QueueName SB-Queue_exampl1 -AuthorizationRuleName SBAuthoRule1
```

The primary and secondary connection strings are returned for the given Service Bus queue.
Returns the primary and secondary connection strings for the specified Service Bus queue.

## PARAMETERS

Expand Down Expand Up @@ -95,22 +95,24 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## INPUTS

###-ResourceGroup
### -ResourceGroup
System.String

###-NamespaceName

### -NamespaceName
System.String

###-QueueName

### -QueueName
System.String

###-AuthorizationRuleName

### -AuthorizationRuleName
System.String

## OUTPUTS

### Microsoft.Azure.Commands.ServiceBus.Models.ListKeysAttributes

PrimaryConnectionString : Endpoint=sb://sb-example1.servicebus.windows.net/;SharedAccessKeyName=SBAuthoRule1;SharedAccessKey={SharedAccessKey-value};EntityPath=SB-Queue_e
xampl1
SecondaryConnectionString : Endpoint=sb://sb-example1.servicebus.windows.net/;SharedAccessKeyName=SBAuthoRule1;SharedAccessKey={SharedAccessKey-value};EntityPath=SB-Queue_e
Expand Down
16 changes: 9 additions & 7 deletions ...anager/ServiceBus/Commands.ServiceBus/help/Get-AzureRmServiceBusSubscription.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The **Get-AzureRmServiceBusSubscription** cmdlet returns a subscription descript
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 Service Bus Topic.
Returns a subscription description for the specified Service Bus topic.

## PARAMETERS

Expand Down Expand Up @@ -94,24 +94,26 @@ Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

## INPUTS
###-ResourceGroup

### -ResourceGroup
System.String

###-NamespaceName

### -NamespaceName
System.String

###-TopicName

### -TopicName
System.String

###-SubscriptionName

### -SubscriptionName
System.String



## OUTPUTS

### Microsoft.Azure.Commands.ServiceBus.Models.SubscriptionAttributes

Name : SB-TopicSubscription-Example1
Location : West US
AccessedAt : 1/20/2017 3:18:54 AM
Expand Down
12 changes: 6 additions & 6 deletions ...sourceManager/ServiceBus/Commands.ServiceBus/help/Get-AzureRmServiceBusTopic.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The **Get-AzureRmServiceBusTopic** cmdlet returns a topic description for the sp
PS C:\> Get-AzureRmServiceBusTopic -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -TopicName SB-Topic_exampl1
```

Returns the description of the specified topic for given Service Bus namespace.
Returns the description of the specified topic for the given Service Bus namespace.

## PARAMETERS

Expand Down Expand Up @@ -80,19 +80,20 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## INPUTS

###-ResourceGroup
### -ResourceGroup
System.String

###-NamespaceName

### -NamespaceName
System.String

###-TopicName

### -TopicName
System.String

## OUTPUTS

### Microsoft.Azure.Commands.ServiceBus.Models.TopicAttributes

Name : SB-Topic_exampl1
Location : West US
Id : /subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.ServiceBus/namespaces/SB-Example1/topics/S
Expand Down Expand Up @@ -120,7 +121,6 @@ SubscriptionCount : 1
SupportOrdering : False
UpdatedAt : 1/20/2017 3:16:43 AM


## NOTES

## RELATED LINKS
Expand Down
13 changes: 7 additions & 6 deletions ...viceBus/Commands.ServiceBus/help/Get-AzureRmServiceBusTopicAuthorizationRule.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,22 +95,24 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## INPUTS

###-ResourceGroup
### -ResourceGroup
System.String

###-NamespaceName

### -NamespaceName
System.String

###-TopicName

### -TopicName
System.String

###-AuthorizationRuleName

### -AuthorizationRuleName
System.String

## OUTPUTS

### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.ServiceBus.Models.SharedAccessAuthorizationRuleAttributes, Microsoft.Azure.Commands.ServiceBus, Version=0.0.1.0, Culture=neutral, PublicKeyToken=null]]

Id : /subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.ServiceBus/namespaces/SB-Example1/topics/SB-Topic_example1/authorizati
onRules/SBTopicAuthoRule1
Type : Microsoft.ServiceBus/AuthorizationRules
Expand All @@ -119,7 +121,6 @@ Location : West US
Tags :
Rights : {Listen, Send}


## NOTES

## RELATED LINKS
Expand Down
13 changes: 8 additions & 5 deletions ...rceManager/ServiceBus/Commands.ServiceBus/help/Get-AzureRmServiceBusTopicKey.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The **Get-AzureRmServiceBusTopicKey** cmdlet returns the primary and secondary c
PS C:\> Get-AzureRmServiceBusTopicKey -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -TopicName SB-Topic_exampl1 -AuthorizationRuleName SBTopicAuthoRule1
```

The primary and secondary connection strings are returned for the given Service Bus topic.
Returns the primary and secondary connection strings for the specified Service Bus topic.

## PARAMETERS

Expand Down Expand Up @@ -95,16 +95,19 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## INPUTS

###-ResourceGroup
### -ResourceGroup
System.String

###-NamespaceName

### -NamespaceName
System.String

###-TopicName

### -TopicName
System.String

###-AuthorizationRuleName

### -AuthorizationRuleName
System.String

## OUTPUTS
Expand Down
Loading