From 441d6eb6b7d4b325accf274b2241eecdb3edc373 Mon Sep 17 00:00:00 2001 From: Yufan Yang <95342181+CaptainFanZzz@users.noreply.github.com> Date: Wed, 22 Jun 2022 16:25:51 +0800 Subject: [PATCH] format the help markdown files of Az.EventHub (#18613) * format the help markdown file of Az.EventHub * format the help markdown files of Az.EventHub Co-authored-by: Ziyue Zheng --- .../EventHub/help/Get-AzEventHubKey.md | 2 +- src/EventHub/EventHub/help/New-AzEventHub.md | 2 +- .../help/New-AzEventHubEncryptionConfig.md | 2 +- .../EventHub/help/New-AzEventHubNamespace.md | 20 +++++++++---------- src/EventHub/EventHub/help/Set-AzEventHub.md | 2 +- .../EventHub/help/Set-AzEventHubNamespace.md | 2 +- 6 files changed, 15 insertions(+), 15 deletions(-) diff --git a/src/EventHub/EventHub/help/Get-AzEventHubKey.md b/src/EventHub/EventHub/help/Get-AzEventHubKey.md index 1424d30780bc..2ed5572abd44 100644 --- a/src/EventHub/EventHub/help/Get-AzEventHubKey.md +++ b/src/EventHub/EventHub/help/Get-AzEventHubKey.md @@ -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\`. diff --git a/src/EventHub/EventHub/help/New-AzEventHub.md b/src/EventHub/EventHub/help/New-AzEventHub.md index 41fe1a70aac5..2c6977645ed1 100644 --- a/src/EventHub/EventHub/help/New-AzEventHub.md +++ b/src/EventHub/EventHub/help/New-AzEventHub.md @@ -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\`. diff --git a/src/EventHub/EventHub/help/New-AzEventHubEncryptionConfig.md b/src/EventHub/EventHub/help/New-AzEventHubEncryptionConfig.md index 23e66cefbaf1..657a1e06ef64 100644 --- a/src/EventHub/EventHub/help/New-AzEventHubEncryptionConfig.md +++ b/src/EventHub/EventHub/help/New-AzEventHubEncryptionConfig.md @@ -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 diff --git a/src/EventHub/EventHub/help/New-AzEventHubNamespace.md b/src/EventHub/EventHub/help/New-AzEventHubNamespace.md index 875539bd7c9f..9e46920f3e8a 100644 --- a/src/EventHub/EventHub/help/New-AzEventHubNamespace.md +++ b/src/EventHub/EventHub/help/New-AzEventHubNamespace.md @@ -35,17 +35,17 @@ New-AzEventHubNamespace [-ResourceGroupName] [-Name] [-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 @@ -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 @@ -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 @@ -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' diff --git a/src/EventHub/EventHub/help/Set-AzEventHub.md b/src/EventHub/EventHub/help/Set-AzEventHub.md index 19021f07ca19..eb7cc8f3c8fe 100644 --- a/src/EventHub/EventHub/help/Set-AzEventHub.md +++ b/src/EventHub/EventHub/help/Set-AzEventHub.md @@ -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. diff --git a/src/EventHub/EventHub/help/Set-AzEventHubNamespace.md b/src/EventHub/EventHub/help/Set-AzEventHubNamespace.md index e62ea4ee5106..41467d970290 100644 --- a/src/EventHub/EventHub/help/Set-AzEventHubNamespace.md +++ b/src/EventHub/EventHub/help/Set-AzEventHubNamespace.md @@ -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