Skip to content

Commit

Permalink
format the help markdown files of Az.EventHub (#18613)
Browse files Browse the repository at this point in the history
* format the help markdown file of Az.EventHub

* format the help markdown files of Az.EventHub

Co-authored-by: Ziyue Zheng <v-ziyzhe@microsoft.com>
  • Loading branch information
CaptainFanZzz and ziyuezh576 authored Jun 22, 2022
1 parent 6e81436 commit 441d6eb
Show file tree
Hide file tree
Showing 6 changed files with 15 additions and 15 deletions.
2 changes: 1 addition & 1 deletion src/EventHub/EventHub/help/Get-AzEventHubKey.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Gets details of Primary and Secondary connectionstrings and keys for the authori

### Example 3: Alias (GeoRecovery Configuration)
```powershell
Get-AzEventHubKey -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -EventHubName MyEventHubName -AliasName MyAliasName -Name MyAuthRuleName
Get-AzEventHubKey -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -AliasName MyAliasName -Name MyAuthRuleName
```

Gets details of Primary, Secondary, AliasPrimary and AliasSecondary connectionstrings and keys for the authorization rule \`MyAuthRuleName\`.
Expand Down
2 changes: 1 addition & 1 deletion src/EventHub/EventHub/help/New-AzEventHub.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ $createdEventHub.CaptureDescription.Destination.Name = "EventHubArchive.AzureBlo
$createdEventHub.CaptureDescription.Destination.BlobContainer = "container"
$createdEventHub.CaptureDescription.Destination.ArchiveNameFormat = "{Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}"
$createdEventHub.CaptureDescription.Destination.StorageAccountResourceId = "/subscriptions/{SubscriptionId}/resourceGroups/MyResourceGroupName/providers/Microsoft.ClassicStorage/storageAccounts/arjunteststorage"
Set-AzEventHub -ResourceGroupName MyResourceGroupName -Namespace MyNamespaceName -Name MyEventHubName -InputObject MyCreatedEventHub -messageRetentionInDays 4 -partitionCount 2
Set-AzEventHub -ResourceGroupName MyResourceGroupName -Namespace MyNamespaceName -Name MyEventHubName -InputObject $createdEventHub
```

Creates an Event Hub named \`MyEventHubName\` with a 3-day message retention period, 2 partitions and CaptureDescription properties in the \`WestUS\` location, with resource group \`MyResourceGroupName\`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The **New-AzEventHubEncryptionConfig** creates an in memory object. This command

### Example 1
```powershell
PS C:\> New-AzEventHubEncryptionConfig -KeyName key1 -KeyVaultUri https://myvaultname.vault.azure.net -UserAssignedIdentity /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MSIName2
New-AzEventHubEncryptionConfig -KeyName key1 -KeyVaultUri https://myvaultname.vault.azure.net -UserAssignedIdentity '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MSIName2'
```

Refer the doc for New-AzEventHubNamespace and Set-AzEventHubNamespace on how to use this further
Expand Down
20 changes: 10 additions & 10 deletions src/EventHub/EventHub/help/New-AzEventHubNamespace.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,17 +35,17 @@ New-AzEventHubNamespace [-ResourceGroupName] <String> [-Name] <String> [-Locatio
The New-AzEventHubNamespace cmdlet creates a new namespace of type Event Hubs.

## EXAMPLES
### Example 1
### Example 1
```powershell
New-AzEventHubNamespace -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -Location MyLocation
```

```output
Name : MyNamespaceName
Id : /subscriptions/{subscriptionId}/resourceGroups/Default-EventHub-WestCentralUS/providers/Microsoft.EventHub/namespaces/MyNamespaceName
ResourceGroupName : Default-EventHub-WestCentralUS
Location : West US
Sku : Name : Standard , Capacity : 1 , Tier : Standard
Name : MyNamespaceName
Id : /subscriptions/{subscriptionId}/resourceGroups/Default-EventHub-WestCentralUS/providers/Microsoft.EventHub/namespaces/MyNamespaceName
ResourceGroupName : Default-EventHub-WestCentralUS
Location : West US
Sku : Name : Standard , Capacity : 1 , Tier : Standard
Tags :
ProvisioningState : Succeeded
Status : Active
Expand Down Expand Up @@ -170,7 +170,7 @@ Creates an Event Hubs namespace \`MyNamespaceName\` in the specified geographic

### Example 5: Creating Namespace with Manage Identity in a cluster
```powershell
New-AzEventHubNamespace -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -Location MyLocation --EnableAutoInflate -MaximumThroughputUnits 12 -EnableKafka -ZoneRedundant -IdentityType SystemAssigned
New-AzEventHubNamespace -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -Location MyLocation -EnableAutoInflate -MaximumThroughputUnits 12 -EnableKafka -ZoneRedundant -IdentityType SystemAssigned
```

```output
Expand All @@ -189,7 +189,7 @@ Enabled : True
IsAutoInflateEnabled : True
MaximumThroughputUnits : 12
ZoneRedundant : True
ClusterArmId : /subscriptions/{subscriptionId}/resourceGroups/Default-EventHub-WestCentralUS/providers/Microsoft.EventHub/clusters/TestCluster
ClusterArmId : /subscriptions/{subscriptionId}/resourceGroups/Default-EventHub-WestCentralUS/providers/Microsoft.EventHub/clusters/TestCluster
Identity.PrincipalId : ##########
Identity.TenantId : ##########
Identity.Type : SystemAssigned
Expand All @@ -204,10 +204,10 @@ Encryption.KeyVaultProperties :
```powershell
# Create encryption config that will create an in memory config object
$config1 = New-AzEventHubEncryptionConfig -KeyName key1 -KeyVaultUri https://myvaultname.vault.azure.net -UserAssignedIdentity /subscriptions/{subscriptionId}/resourceGroups/{resourcegroup}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MSIName
$config1 = New-AzEventHubEncryptionConfig -KeyName key1 -KeyVaultUri https://myvaultname.vault.azure.net -UserAssignedIdentity '/subscriptions/{subscriptionId}/resourceGroups/{resourcegroup}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MSIName'
# Create encryption config that will create an in memory config object
$config2 = New-AzEventHubEncryptionConfig -KeyName key2 -KeyVaultUri https://myvaultname.vault.azure.net -UserAssignedIdentity /subscriptions/{subscriptionId}/resourceGroups/{resourcegroup}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MSIName
$config2 = New-AzEventHubEncryptionConfig -KeyName key2 -KeyVaultUri https://myvaultname.vault.azure.net -UserAssignedIdentity '/subscriptions/{subscriptionId}/resourceGroups/{resourcegroup}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MSIName'
$id1 = '/subscriptions/{subscriptionId}/resourceGroups/{resourcegroup}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MSIName'
Expand Down
2 changes: 1 addition & 1 deletion src/EventHub/EventHub/help/Set-AzEventHub.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Updates the Event Hub \`MyEventHubName\` represented by the \`MyCreatedEventHub\

### Example 2
```powershell
Set-AzEventHub -ResourceGroupName MyResourceGroupName -Namespace MyNamespaceName -Name MyEventHubName -InputObject MyCreatedEventHub -messageRetentionInDays 4 -partitionCount 2
Set-AzEventHub -ResourceGroupName MyResourceGroupName -Namespace MyNamespaceName -Name MyEventHubName -messageRetentionInDays 4 -partitionCount 2
```

Updates the Event Hub \`MyEventHubName\` represented by the \`MyCreatedEventHub\` object, setting the message retention period to 4 days, and the number of partitions to 2.
Expand Down
2 changes: 1 addition & 1 deletion src/EventHub/EventHub/help/Set-AzEventHubNamespace.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Updates the Tags for namespace \`MyNamespaceName\` to Created .

### Example 2
```powershell
Set-AzEventHubNamespace -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -Location "WestUS" -State Created -EnableAutoInflate -MaximumThroughputUnits 10
Set-AzEventHubNamespace -ResourceGroupName MyResourceGroupName -NamespaceName MyNamespaceName -Location "WestUS" -EnableAutoInflate -MaximumThroughputUnits 10
```

```output
Expand Down

0 comments on commit 441d6eb

Please sign in to comment.