Skip to content

ServiceBus Command Help files #3422

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 6 commits into from
Feb 3, 2017
Merged

ServiceBus Command Help files #3422

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6fd5233
Command Help files
Jan 25, 2017
1ddca5c
updating the Service Bus PowerShell documentation
Feb 2, 2017
e5bc928
Merge pull request #1 from jtaubensee/service_bus_doc_updates
Feb 2, 2017
0f89261
Updated the xml Help file.
Feb 2, 2017
16504fc
fixed 3 cmdlets markdown and updated xml help file.
Feb 3, 2017
f9a46d7
fix for CredScan issue.
Feb 3, 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
1,860 changes: 1,283 additions & 577 deletions ...ceManager/ServiceBus/Commands.ServiceBus/Microsoft.Azure.Commands.ServiceBus.dll-Help.xml
View file
Open in desktop

Large diffs are not rendered by default.

30 changes: 23 additions & 7 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 @@ -7,7 +7,7 @@ schema: 2.0.0
# Get-AzureRmServiceBusNamespace

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

## SYNTAX

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

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

## EXAMPLES

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

{{ Add example description here }}
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 All @@ -64,12 +64,28 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## INPUTS

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

###-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
Sku : Name : Standard , Capacity : 1 , Tier : Standard
ProvisioningState : Succeeded
Status : Active
CreatedAt : 1/20/2017 1:40:01 AM
UpdatedAt : 1/20/2017 1:40:24 AM
ServiceBusEndpoint : https://SB-Example1.servicebus.windows.net:443/
Enabled : True


## NOTES

## RELATED LINKS
Expand Down
31 changes: 23 additions & 8 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 @@ -7,7 +7,7 @@ schema: 2.0.0
# Get-AzureRmServiceBusNamespaceAuthorizationRule

## SYNOPSIS
{{Fill in the Synopsis}}
Gets a description of the specified authorization rule for a given namespace.

## SYNTAX

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

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

## EXAMPLES

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

{{ Add example description here }}
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 All @@ -80,12 +80,27 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## INPUTS

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

###-NamespaceName
System.String

###-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
29 changes: 21 additions & 8 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 @@ -7,7 +7,7 @@ schema: 2.0.0
# Get-AzureRmServiceBusNamespaceKey

## SYNOPSIS
{{Fill in the Synopsis}}
Gets the primary and secondary connection strings for the namespace.

## SYNTAX

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

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

## EXAMPLES

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

{{ Add example description here }}
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 All @@ -80,12 +80,25 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## INPUTS

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

###-NamespaceName
System.String

###-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}
SecondaryKey : {SecondaryKey value}
KeyName : AuthoRule1

## NOTES

## RELATED LINKS
Expand Down
50 changes: 42 additions & 8 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 @@ -7,7 +7,7 @@ schema: 2.0.0
# Get-AzureRmServiceBusQueue

## SYNOPSIS
{{Fill in the Synopsis}}
Returns a description for the specified Service Bus queue.

## SYNTAX

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

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

## EXAMPLES

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

{{ Add example description here }}
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 All @@ -80,11 +80,45 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## INPUTS

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

###-NamespaceName
System.String

###-QueueName
System.String

## OUTPUTS

### Microsoft.Azure.Commands.ServiceBus.Models.QueueAttributes
LockDuration :
AccessedAt : 1/1/0001 12:00:00 AM
AutoDeleteOnIdle : 10675199.02:48:05.4775807
EntityAvailabilityStatus :
CreatedAt : 1/20/2017 2:51:35 AM
DefaultMessageTimeToLive : 10675199.02:48:05.4775807
DuplicateDetectionHistoryTimeWindow :
EnableBatchedOperations : True
DeadLetteringOnMessageExpiration : False
EnableExpress : False
EnablePartitioning : True
IsAnonymousAccessible : False
MaxDeliveryCount :
MaxSizeInMegabytes : 16384
MessageCount :
CountDetails : Microsoft.Azure.Management.ServiceBus.Models.MessageCountDetails
RequiresDuplicateDetection : False
RequiresSession : False
SizeInBytes :
Status : Active
SupportOrdering : False
UpdatedAt : 1/20/2017 2:51:37 AM
Id : /subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.ServiceBus/namespaces/SB-Example1/queues/S
B-Queue_example1
Name : SB-Queue_example1
Type : Microsoft.ServiceBus/Queues
Location : West US

## NOTES

Expand Down
Loading