Skip to content

Commit a2914d1

Browse files
cormacpaynecormacpayne
authored
Merge pull request #3422 from v-Ajnava/AJ_SBPower
ServiceBus Command Help files
2 parents b579697 + f9a46d7 commit a2914d1

35 files changed

+2346
-949
lines changed

‎src/ResourceManager/ServiceBus/Commands.ServiceBus/Microsoft.Azure.Commands.ServiceBus.dll-Help.xml

Lines changed: 1283 additions & 577 deletions
Large diffs are not rendered by default.

‎src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Get-AzureRmServiceBusNamespace.md

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ schema: 2.0.0
77
# Get-AzureRmServiceBusNamespace
88

99
## SYNOPSIS
10-
{{Fill in the Synopsis}}
10+
Gets a description for the specified Service Bus namespace within the resource group.
1111

1212
## SYNTAX
1313

@@ -16,21 +16,21 @@ Get-AzureRmServiceBusNamespace [[-ResourceGroup] <String>] [[-NamespaceName] <St
1616
```
1717

1818
## DESCRIPTION
19-
{{Fill in the Description}}
19+
The **Get-AzureRmServiceBusNamespace** cmdlet gets a description for the specified Service Bus namespace within the resource group.
2020

2121
## EXAMPLES
2222

2323
### Example 1
2424
```
25-
PS C:\> {{ Add example code here }}
25+
PS C:\> Get-AzureRmServiceBusNamespace -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1
2626
```
2727

28-
{{ Add example description here }}
28+
Returns a description of the specified Service Bus namespace.
2929

3030
## PARAMETERS
3131

3232
### -NamespaceName
33-
Namespace Name.
33+
Namespace name.
3434

3535
```yaml
3636
Type: String
@@ -45,7 +45,7 @@ Accept wildcard characters: False
4545
```
4646
4747
### -ResourceGroup
48-
The name of the resource group
48+
The name of the resource group.
4949
5050
```yaml
5151
Type: String
@@ -64,12 +64,28 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
6464
6565
## INPUTS
6666
67-
### System.String
67+
###-ResourceGroup
68+
System.String
69+
70+
###-NamespaceName
71+
System.String
6872
6973
## OUTPUTS
7074
7175
### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.ServiceBus.Models.NamespaceAttributes, Microsoft.Azure.Commands.ServiceBus, Version=0.0.1.0, Culture=neutral, PublicKeyToken=null]]
7276

77+
Name : SB-Example1
78+
Id : /subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.ServiceBus/namespaces/SB-Example1
79+
Location : West US
80+
Sku : Name : Standard , Capacity : 1 , Tier : Standard
81+
ProvisioningState : Succeeded
82+
Status : Active
83+
CreatedAt : 1/20/2017 1:40:01 AM
84+
UpdatedAt : 1/20/2017 1:40:24 AM
85+
ServiceBusEndpoint : https://SB-Example1.servicebus.windows.net:443/
86+
Enabled : True
87+
88+
7389
## NOTES
7490

7591
## RELATED LINKS

‎src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Get-AzureRmServiceBusNamespaceAuthorizationRule.md

Lines changed: 23 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ schema: 2.0.0
77
# Get-AzureRmServiceBusNamespaceAuthorizationRule
88

99
## SYNOPSIS
10-
{{Fill in the Synopsis}}
10+
Gets a description of the specified authorization rule for a given namespace.
1111

1212
## SYNTAX
1313

@@ -17,21 +17,21 @@ Get-AzureRmServiceBusNamespaceAuthorizationRule [-ResourceGroup] <String> [-Name
1717
```
1818

1919
## DESCRIPTION
20-
{{Fill in the Description}}
20+
The **Get-AzureRmServiceBusNamespaceAuthorizationRule** cmdlet gets the description of the specified authorization rule in the given namespace.
2121

2222
## EXAMPLES
2323

2424
### Example 1
2525
```
26-
PS C:\> {{ Add example code here }}
26+
PS C:\> Get-AzureRmServiceBusNamespaceAuthorizationRule -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -AuthorizationRuleName AuthoRule1
2727
```
2828

29-
{{ Add example description here }}
29+
Returns the specified authorization rule description for a specified namespace.
3030

3131
## PARAMETERS
3232

3333
### -AuthorizationRuleName
34-
ServiceBus Namespace AuthorizationRule Name.
34+
The Service Bus namespace authorization rule name.
3535

3636
```yaml
3737
Type: String
@@ -46,7 +46,7 @@ Accept wildcard characters: False
4646
```
4747
4848
### -NamespaceName
49-
ServiceBus Namespace Name.
49+
The Service Bus namespace name.
5050
5151
```yaml
5252
Type: String
@@ -61,7 +61,7 @@ Accept wildcard characters: False
6161
```
6262
6363
### -ResourceGroup
64-
The name of the resource group
64+
The name of the resource group.
6565
6666
```yaml
6767
Type: String
@@ -80,12 +80,27 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
8080
8181
## INPUTS
8282
83-
### System.String
83+
###-ResourceGroup
84+
System.String
85+
86+
###-NamespaceName
87+
System.String
88+
89+
###-AuthorizationRuleName
90+
System.String
8491
8592
## OUTPUTS
8693
8794
### System.Collections.Generic.List`1[[Microsoft.Azure.Commands.ServiceBus.Models.SharedAccessAuthorizationRuleAttributes, Microsoft.Azure.Commands.ServiceBus, Version=0.0.1.0, Culture=neutral, PublicKeyToken=null]]
8895

96+
Id : /subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.ServiceBus/namespaces/SB-Example1/AuthorizationRules/AuthoRule1
97+
Type : Microsoft.ServiceBus/AuthorizationRules
98+
Name : AuthoRule1
99+
Location :
100+
Tags :
101+
Rights : {Listen, Send}
102+
103+
89104
## NOTES
90105

91106
## RELATED LINKS

‎src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Get-AzureRmServiceBusNamespaceKey.md

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ schema: 2.0.0
77
# Get-AzureRmServiceBusNamespaceKey
88

99
## SYNOPSIS
10-
{{Fill in the Synopsis}}
10+
Gets the primary and secondary connection strings for the namespace.
1111

1212
## SYNTAX
1313

@@ -17,21 +17,21 @@ Get-AzureRmServiceBusNamespaceKey [-ResourceGroup] <String> [-NamespaceName] <St
1717
```
1818

1919
## DESCRIPTION
20-
{{Fill in the Description}}
20+
The **Get-AzureRmServiceBusNamespaceKey** cmdlet returns the primary and secondary connection strings for the given namespace.
2121

2222
## EXAMPLES
2323

2424
### Example 1
2525
```
26-
PS C:\> {{ Add example code here }}
26+
PS C:\> Get-AzureRmServiceBusNamespaceKey -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -AuthorizationRuleName AuthoRule1
2727
```
2828

29-
{{ Add example description here }}
29+
Primary and secondary connection string to the specified namespace.
3030

3131
## PARAMETERS
3232

3333
### -AuthorizationRuleName
34-
ServiceBus Namespace AuthorizationRule Name.
34+
Service Bus namespace authorization rule name.
3535

3636
```yaml
3737
Type: String
@@ -46,7 +46,7 @@ Accept wildcard characters: False
4646
```
4747
4848
### -NamespaceName
49-
ServiceBus Namespace Name.
49+
Service Bus namespace name.
5050
5151
```yaml
5252
Type: String
@@ -61,7 +61,7 @@ Accept wildcard characters: False
6161
```
6262
6363
### -ResourceGroup
64-
The name of the resource group
64+
The name of the resource group.
6565
6666
```yaml
6767
Type: String
@@ -80,12 +80,25 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
8080
8181
## INPUTS
8282
83-
### System.String
83+
###-ResourceGroup
84+
System.String
85+
86+
###-NamespaceName
87+
System.String
88+
89+
###-AuthorizationRuleName
90+
System.String
8491
8592
## OUTPUTS
8693
8794
### Microsoft.Azure.Management.ServiceBus.Models.ResourceListKeys
8895
96+
PrimaryConnectionString : Endpoint=sb://sb-example1.servicebus.windows.net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey={SharedAccessKey value}
97+
SecondaryConnectionString : Endpoint=sb://sb-example1.servicebus.windows.net/;SharedAccessKeyName=AuthoRule1;SharedAccessKey={SharedAccessKey value}
98+
PrimaryKey : {PrimaryKey value}
99+
SecondaryKey : {SecondaryKey value}
100+
KeyName : AuthoRule1
101+
89102
## NOTES
90103
91104
## RELATED LINKS

‎src/ResourceManager/ServiceBus/Commands.ServiceBus/help/Get-AzureRmServiceBusQueue.md

Lines changed: 42 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ schema: 2.0.0
77
# Get-AzureRmServiceBusQueue
88

99
## SYNOPSIS
10-
{{Fill in the Synopsis}}
10+
Returns a description for the specified Service Bus queue.
1111

1212
## SYNTAX
1313

@@ -17,21 +17,21 @@ Get-AzureRmServiceBusQueue [-ResourceGroup] <String> [-NamespaceName] <String> [
1717
```
1818

1919
## DESCRIPTION
20-
{{Fill in the Description}}
20+
The **Get-AzureRmServiceBusQueue** cmdlet returns a description of the specified Service Bus queue.
2121

2222
## EXAMPLES
2323

2424
### Example 1
2525
```
26-
PS C:\> {{ Add example code here }}
26+
PS C:\> Get-AzureRmServiceBusQueue -ResourceGroup Default-ServiceBus-WestUS -NamespaceName SB-Example1 -QueueName SB-Queue_example1
2727
```
2828

29-
{{ Add example description here }}
29+
Returns the description of the queue.
3030

3131
## PARAMETERS
3232

3333
### -NamespaceName
34-
Namespace Name.
34+
The Service Bus namespace name.
3535

3636
```yaml
3737
Type: String
@@ -46,7 +46,7 @@ Accept wildcard characters: False
4646
```
4747
4848
### -QueueName
49-
Queue Name.
49+
The queue name.
5050
5151
```yaml
5252
Type: String
@@ -61,7 +61,7 @@ Accept wildcard characters: False
6161
```
6262
6363
### -ResourceGroup
64-
The name of the resource group
64+
The name of the resource group.
6565
6666
```yaml
6767
Type: String
@@ -80,11 +80,45 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
8080
8181
## INPUTS
8282
83-
### System.String
83+
###-ResourceGroup
84+
System.String
85+
86+
###-NamespaceName
87+
System.String
88+
89+
###-QueueName
90+
System.String
8491
8592
## OUTPUTS
8693
8794
### Microsoft.Azure.Commands.ServiceBus.Models.QueueAttributes
95+
LockDuration :
96+
AccessedAt : 1/1/0001 12:00:00 AM
97+
AutoDeleteOnIdle : 10675199.02:48:05.4775807
98+
EntityAvailabilityStatus :
99+
CreatedAt : 1/20/2017 2:51:35 AM
100+
DefaultMessageTimeToLive : 10675199.02:48:05.4775807
101+
DuplicateDetectionHistoryTimeWindow :
102+
EnableBatchedOperations : True
103+
DeadLetteringOnMessageExpiration : False
104+
EnableExpress : False
105+
EnablePartitioning : True
106+
IsAnonymousAccessible : False
107+
MaxDeliveryCount :
108+
MaxSizeInMegabytes : 16384
109+
MessageCount :
110+
CountDetails : Microsoft.Azure.Management.ServiceBus.Models.MessageCountDetails
111+
RequiresDuplicateDetection : False
112+
RequiresSession : False
113+
SizeInBytes :
114+
Status : Active
115+
SupportOrdering : False
116+
UpdatedAt : 1/20/2017 2:51:37 AM
117+
Id : /subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.ServiceBus/namespaces/SB-Example1/queues/S
118+
B-Queue_example1
119+
Name : SB-Queue_example1
120+
Type : Microsoft.ServiceBus/Queues
121+
Location : West US
88122
89123
## NOTES
90124

0 commit comments

Comments
 (0)