From f39faba25805dabc4b2b936183e20b7cd5e1103c Mon Sep 17 00:00:00 2001 From: unknown Date: Tue, 29 Nov 2022 01:05:01 +0530 Subject: [PATCH] Doc fixes --- .../docs/Get-AzEventHubNamespaceV2.md | 4 +- .../docs/Get-AzEventHubSchemaGroup.md | 4 +- .../New-AzEventHubKeyVaultPropertiesObject.md | 2 +- .../docs/New-AzEventHubNamespaceV2.md | 30 +++---- .../docs/New-AzEventHubSchemaGroup.md | 4 +- .../docs/Remove-AzEventHubSchemaGroup.md | 4 +- .../docs/Set-AzEventHubNamespaceV2.md | 82 +++++++++---------- .../examples/Get-AzEventHubNamespaceV2.md | 4 +- .../New-AzEventHubKeyVaultPropertiesObject.md | 2 +- .../examples/New-AzEventHubNamespaceV2.md | 30 +++---- .../examples/Set-AzEventHubNamespaceV2.md | 82 +++++++++---------- .../ServiceBus.Autorest/custom/README.md | 2 +- .../docs/Get-AzServiceBusNamespaceV2.md | 16 ++-- .../New-AzServiceBusGeoDRConfiguration.md | 6 +- ...ew-AzServiceBusKeyVaultPropertiesObject.md | 10 +-- .../docs/New-AzServiceBusNamespaceV2.md | 32 ++++---- .../ServiceBus.Autorest/docs/README.md | 2 +- .../docs/Set-AzServiceBusNamespaceV2.md | 54 ++++++------ .../examples/Get-AzServiceBusNamespaceV2.md | 16 ++-- .../New-AzServiceBusGeoDRConfiguration.md | 6 +- ...ew-AzServiceBusKeyVaultPropertiesObject.md | 10 +-- .../examples/New-AzServiceBusNamespaceV2.md | 32 ++++---- .../examples/Set-AzServiceBusNamespaceV2.md | 54 ++++++------ src/ServiceBus/ServiceBus.Autorest/how-to.md | 2 +- 24 files changed, 245 insertions(+), 245 deletions(-) diff --git a/src/EventHub/EventHub.Autorest/docs/Get-AzEventHubNamespaceV2.md b/src/EventHub/EventHub.Autorest/docs/Get-AzEventHubNamespaceV2.md index 5ec14f91ffa2..4ee66364b77e 100644 --- a/src/EventHub/EventHub.Autorest/docs/Get-AzEventHubNamespaceV2.md +++ b/src/EventHub/EventHub.Autorest/docs/Get-AzEventHubNamespaceV2.md @@ -50,14 +50,14 @@ ClusterArmId : CreatedAt : 11/17/2022 3:14:09 PM DisableLocalAuth : True EnableAutoInflate : True -Id : /subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace +Id : /subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace IdentityType : KafkaEnabled : True KeySource : KeyVaultProperty : Location : South Central US MaximumThroughputUnit : 0 -MetricId : {subscriptionId}:myNamespace +MetricId : 000000000000000:myNamespace MinimumTlsVersion : 1.2 Name : myNamespace PrincipalId : 000000000000000000 diff --git a/src/EventHub/EventHub.Autorest/docs/Get-AzEventHubSchemaGroup.md b/src/EventHub/EventHub.Autorest/docs/Get-AzEventHubSchemaGroup.md index 91bfc4b517e3..98c14a649ffb 100644 --- a/src/EventHub/EventHub.Autorest/docs/Get-AzEventHubSchemaGroup.md +++ b/src/EventHub/EventHub.Autorest/docs/Get-AzEventHubSchemaGroup.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-AzEventHubSchemaGroup ## SYNOPSIS - +Gets the specified Schema Group ## SYNTAX @@ -30,7 +30,7 @@ Get-AzEventHubSchemaGroup -InputObject [-DefaultProfile -NamespaceName -ResourceGroupN ``` ## DESCRIPTION - +Creates a new EventHub schema group. ## EXAMPLES diff --git a/src/EventHub/EventHub.Autorest/docs/Remove-AzEventHubSchemaGroup.md b/src/EventHub/EventHub.Autorest/docs/Remove-AzEventHubSchemaGroup.md index 185a2445027f..acc7c4b9e0f5 100644 --- a/src/EventHub/EventHub.Autorest/docs/Remove-AzEventHubSchemaGroup.md +++ b/src/EventHub/EventHub.Autorest/docs/Remove-AzEventHubSchemaGroup.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Remove-AzEventHubSchemaGroup ## SYNOPSIS - +Deletes an EventHub schema group. ## SYNTAX @@ -25,7 +25,7 @@ Remove-AzEventHubSchemaGroup -InputObject [-DefaultProfile < ``` ## DESCRIPTION - +Deletes an EventHub schema group. ## EXAMPLES diff --git a/src/EventHub/EventHub.Autorest/docs/Set-AzEventHubNamespaceV2.md b/src/EventHub/EventHub.Autorest/docs/Set-AzEventHubNamespaceV2.md index ad1a6d49a2c1..cd8a5dbd3aab 100644 --- a/src/EventHub/EventHub.Autorest/docs/Set-AzEventHubNamespaceV2.md +++ b/src/EventHub/EventHub.Autorest/docs/Set-AzEventHubNamespaceV2.md @@ -44,7 +44,7 @@ $eventHubNamespace = Get-AzEventHubNamespaceV2 -ResourceGroupName myResourceGrou $identityId = $eventHubNamespace.UserAssignedIdentity.Keys -$identityId += "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity" +$identityId += "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity" Set-AzEventHubNamespaceV2 -InputObject $eventHubNamespace -UserAssignedIdentityId $identityId ``` @@ -55,35 +55,35 @@ ClusterArmId : CreatedAt : 11/17/2022 2:56:32 PM DisableLocalAuth : False EnableAutoInflate : False -Id : /subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace +Id : /subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace IdentityType : UserAssigned KafkaEnabled : True KeySource : Microsoft.KeyVault KeyVaultProperty : {{ "identity": { - "userAssignedIdentity": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" + "userAssignedIdentity": "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" }, "keyName": "key1", - "keyVaultUri": "https://{keyVaultName}.vault.azure.net/", + "keyVaultUri": "https://testkeyvault.vault.azure.net/", "keyVersion": "" }, { "identity": { - "userAssignedIdentity": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" + "userAssignedIdentity": "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" }, "keyName": "key2", - "keyVaultUri": "https://{keyVaultName}.vault.azure.net/", + "keyVaultUri": "https://testkeyvault.vault.azure.net/", "keyVersion": "" }, { "identity": { - "userAssignedIdentity": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" + "userAssignedIdentity": "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" }, "keyName": "key3", - "keyVaultUri": "https://{keyVaultName}.vault.azure.net/", + "keyVaultUri": "https://testkeyvault.vault.azure.net/", "keyVersion": "" }} Location : North Europe MaximumThroughputUnit : 0 -MetricId : {subscriptionId}:myNamespace +MetricId : 000000000000000:myNamespace MinimumTlsVersion : 1.2 Name : myNamespace PrincipalId : @@ -103,9 +103,9 @@ TenantId : Type : Microsoft.EventHub/Namespaces UpdatedAt : 11/17/2022 3:03:50 PM UserAssignedIdentity : { - "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity": { + "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity": { }, - "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity": { + "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity": { } } ZoneRedundant : True @@ -121,7 +121,7 @@ keys from the hashtable, which would result in an array of strings which can the ```powershell $eventHubNamespace = Get-AzEventHubNamespaceV2 -ResourceGroupName myResourceGroup -Name myNamespace -$newKeyVaultProperty = New-AzEventHubKeyVaultPropertiesObject -KeyName key3 -KeyVaultUri https://{keyVaultName}.vault.azure.net/ -UserAssignedIdentity "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" +$newKeyVaultProperty = New-AzEventHubKeyVaultPropertiesObject -KeyName key3 -KeyVaultUri https://testkeyvault.vault.azure.net -UserAssignedIdentity "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" $eventHubNamespace.KeyVaultProperty += $newKeyVaultProperty @@ -134,35 +134,35 @@ ClusterArmId : CreatedAt : 11/17/2022 2:56:32 PM DisableLocalAuth : False EnableAutoInflate : False -Id : /subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace +Id : /subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace IdentityType : UserAssigned KafkaEnabled : True KeySource : Microsoft.KeyVault KeyVaultProperty : {{ "identity": { - "userAssignedIdentity": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" + "userAssignedIdentity": "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" }, "keyName": "key1", - "keyVaultUri": "https://{keyVaultName}.vault.azure.net/", + "keyVaultUri": "https://testkeyvault.vault.azure.net", "keyVersion": "" }, { "identity": { - "userAssignedIdentity": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" + "userAssignedIdentity": "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" }, "keyName": "key2", - "keyVaultUri": "https://{keyVaultName}.vault.azure.net/", + "keyVaultUri": "https://testkeyvault.vault.azure.net", "keyVersion": "" }, { "identity": { - "userAssignedIdentity": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" + "userAssignedIdentity": "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" }, "keyName": "key3", - "keyVaultUri": "https://{keyVaultName}.vault.azure.net/", + "keyVaultUri": "https://testkeyvault.vault.azure.net", "keyVersion": "" }} Location : North Europe MaximumThroughputUnit : 0 -MetricId : {subscriptionId}:myNamespace +MetricId : 000000000000000:myNamespace MinimumTlsVersion : 1.2 Name : myNamespace PrincipalId : @@ -182,9 +182,9 @@ TenantId : Type : Microsoft.EventHub/Namespaces UpdatedAt : 11/17/2022 3:03:50 PM UserAssignedIdentity : { - "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity": { + "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity": { }, - "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity": { + "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity": { } } ZoneRedundant : True @@ -208,28 +208,28 @@ ClusterArmId : CreatedAt : 11/17/2022 2:56:32 PM DisableLocalAuth : False EnableAutoInflate : False -Id : /subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace +Id : /subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace IdentityType : UserAssigned KafkaEnabled : True KeySource : Microsoft.KeyVault KeyVaultProperty : {{ "identity": { - "userAssignedIdentity": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" + "userAssignedIdentity": "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" }, "keyName": "key1", - "keyVaultUri": "https://{keyVaultName}.vault.azure.net/", + "keyVaultUri": "https://testkeyvault.vault.azure.net", "keyVersion": "" }, { "identity": { - "userAssignedIdentity": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" + "userAssignedIdentity": "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" }, "keyName": "key2", - "keyVaultUri": "https://{keyVaultName}.vault.azure.net/", + "keyVaultUri": "https://testkeyvault.vault.azure.net", "keyVersion": "" }} Location : North Europe MaximumThroughputUnit : 0 -MetricId : {subscriptionId}:myNamespace +MetricId : 000000000000000:myNamespace MinimumTlsVersion : 1.2 Name : myNamespace PrincipalId : @@ -249,9 +249,9 @@ TenantId : Type : Microsoft.EventHub/Namespaces UpdatedAt : 11/17/2022 3:03:50 PM UserAssignedIdentity : { - "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity": { + "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity": { }, - "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity": { + "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity": { } } ZoneRedundant : True @@ -270,28 +270,28 @@ ClusterArmId : CreatedAt : 11/17/2022 2:56:32 PM DisableLocalAuth : False EnableAutoInflate : False -Id : /subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace +Id : /subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace IdentityType : UserAssigned KafkaEnabled : True KeySource : Microsoft.KeyVault KeyVaultProperty : {{ "identity": { - "userAssignedIdentity": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" + "userAssignedIdentity": "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" }, "keyName": "key1", - "keyVaultUri": "https://{keyVaultName}.vault.azure.net/", + "keyVaultUri": "https://testkeyvault.vault.azure.net", "keyVersion": "" }, { "identity": { - "userAssignedIdentity": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" + "userAssignedIdentity": "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" }, "keyName": "key2", - "keyVaultUri": "https://{keyVaultName}.vault.azure.net/", + "keyVaultUri": "https://testkeyvault.vault.azure.net", "keyVersion": "" }} Location : North Europe MaximumThroughputUnit : 0 -MetricId : {subscriptionId}:myNamespace +MetricId : 000000000000000:myNamespace MinimumTlsVersion : 1.2 Name : myNamespace PrincipalId : @@ -311,9 +311,9 @@ TenantId : Type : Microsoft.EventHub/Namespaces UpdatedAt : 11/17/2022 3:03:50 PM UserAssignedIdentity : { - "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity": { + "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity": { }, - "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity": { + "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity": { } } ZoneRedundant : True @@ -323,7 +323,7 @@ Sets `DisableLocalAuth` to true on an EventHub namespace `myNamespace`. ### Example 5: # Create a namespace with UserAssignedIdentity and use Set-Az cmdlet to set IdentityType to None. ```powershell -$eventHubNamespace = New-AzEventHubNamespaceV2 -ResourceGroupName myResourceGroup -Name myNamespace -SkuName Premium -Location northeurope -IdentityType UserAssigned -UserAssignedIdentityId "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" +$eventHubNamespace = New-AzEventHubNamespaceV2 -ResourceGroupName myResourceGroup -Name myNamespace -SkuName Premium -Location northeurope -IdentityType UserAssigned -UserAssignedIdentityId "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" $eventHubNamespace = Set-AzEventHubNamespaceV2 -ResourceGroupName myResourceGroup -Name myNamespace -IdentityType None -UserAssignedIdentityId:$null ``` @@ -333,7 +333,7 @@ ClusterArmId : CreatedAt : 11/21/2022 3:21:29 PM DisableLocalAuth : False EnableAutoInflate : False -Id : /subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/provide +Id : /subscriptions/000000000000000/resourceGroups/myResourceGroup/provide rs/Microsoft.EventHub/namespaces/myNamespace IdentityType : KafkaEnabled : True @@ -341,7 +341,7 @@ KeySource : KeyVaultProperty : Location : North Europe MaximumThroughputUnit : 0 -MetricId : {subscriptionId}:myNamespace +MetricId : 000000000000000:myNamespace MinimumTlsVersion : 1.2 Name : myNamespace PrincipalId : diff --git a/src/EventHub/EventHub.Autorest/examples/Get-AzEventHubNamespaceV2.md b/src/EventHub/EventHub.Autorest/examples/Get-AzEventHubNamespaceV2.md index 3858a1cbdc7c..5b7231e698ef 100644 --- a/src/EventHub/EventHub.Autorest/examples/Get-AzEventHubNamespaceV2.md +++ b/src/EventHub/EventHub.Autorest/examples/Get-AzEventHubNamespaceV2.md @@ -9,14 +9,14 @@ ClusterArmId : CreatedAt : 11/17/2022 3:14:09 PM DisableLocalAuth : True EnableAutoInflate : True -Id : /subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace +Id : /subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace IdentityType : KafkaEnabled : True KeySource : KeyVaultProperty : Location : South Central US MaximumThroughputUnit : 0 -MetricId : {subscriptionId}:myNamespace +MetricId : 000000000000000:myNamespace MinimumTlsVersion : 1.2 Name : myNamespace PrincipalId : 000000000000000000 diff --git a/src/EventHub/EventHub.Autorest/examples/New-AzEventHubKeyVaultPropertiesObject.md b/src/EventHub/EventHub.Autorest/examples/New-AzEventHubKeyVaultPropertiesObject.md index da823ed843b3..e5e3753c94a7 100644 --- a/src/EventHub/EventHub.Autorest/examples/New-AzEventHubKeyVaultPropertiesObject.md +++ b/src/EventHub/EventHub.Autorest/examples/New-AzEventHubKeyVaultPropertiesObject.md @@ -1,6 +1,6 @@ ### Example 1: Construct an in-memory KeyVaultProperties object ```powershell -New-AzEventHubKeyVaultPropertiesObject -KeyName key1 -KeyVaultUri https://{keyVaultName}.vault.azure.net/ +New-AzEventHubKeyVaultPropertiesObject -KeyName key1 -KeyVaultUri https://testkeyvault.vault.azure.net ``` Creates an in-memory object of type `IKeyVaultProperties`. An array of `IKeyVaultProperties` can be fed as diff --git a/src/EventHub/EventHub.Autorest/examples/New-AzEventHubNamespaceV2.md b/src/EventHub/EventHub.Autorest/examples/New-AzEventHubNamespaceV2.md index c0d84243aaa4..4214ecab2147 100644 --- a/src/EventHub/EventHub.Autorest/examples/New-AzEventHubNamespaceV2.md +++ b/src/EventHub/EventHub.Autorest/examples/New-AzEventHubNamespaceV2.md @@ -1,9 +1,9 @@ ### Example 1: Create a new EventHub namespace with UserAssignedIdentity Encryption ```powershell -$keyVaultProperty1 = New-AzEventHubKeyVaultPropertiesObject -KeyName key1 -KeyVaultUri https://{keyVaultName}.vault.azure.net/ -UserAssignedIdentity "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" -$keyVaultProperty2 = New-AzEventHubKeyVaultPropertiesObject -KeyName key2 -KeyVaultUri https://{keyVaultName}.vault.azure.net/ -UserAssignedIdentity "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity" +$keyVaultProperty1 = New-AzEventHubKeyVaultPropertiesObject -KeyName key1 -KeyVaultUri https://testkeyvault.vault.azure.net -UserAssignedIdentity "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" +$keyVaultProperty2 = New-AzEventHubKeyVaultPropertiesObject -KeyName key2 -KeyVaultUri https://testkeyvault.vault.azure.net -UserAssignedIdentity "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity" -New-AzEventHubNamespaceV2 -ResourceGroupName myResourceGroup -Name myNamespace -SkuName Premium -Location northeurope -IdentityType UserAssigned -UserAssignedIdentityId "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity","/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity" -KeyVaultProperty $keyVaultProperty1,$keyVaultProperty2 +New-AzEventHubNamespaceV2 -ResourceGroupName myResourceGroup -Name myNamespace -SkuName Premium -Location northeurope -IdentityType UserAssigned -UserAssignedIdentityId "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity","/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity" -KeyVaultProperty $keyVaultProperty1,$keyVaultProperty2 ``` ```output @@ -12,28 +12,28 @@ ClusterArmId : CreatedAt : 11/17/2022 2:56:32 PM DisableLocalAuth : False EnableAutoInflate : False -Id : /subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace +Id : /subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace IdentityType : UserAssigned KafkaEnabled : True KeySource : Microsoft.KeyVault KeyVaultProperty : {{ "identity": { - "userAssignedIdentity": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" + "userAssignedIdentity": "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" }, "keyName": "key1", - "keyVaultUri": "https://{keyVaultName}.vault.azure.net/", + "keyVaultUri": "https://testkeyvault.vault.azure.net/", "keyVersion": "" }, { "identity": { - "userAssignedIdentity": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" + "userAssignedIdentity": "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" }, "keyName": "key2", - "keyVaultUri": "https://{keyVaultName}.vault.azure.net/", + "keyVaultUri": "https://testkeyvault.vault.azure.net/", "keyVersion": "" }} Location : North Europe MaximumThroughputUnit : 0 -MetricId : {subscriptionId}:myNamespace +MetricId : 000000000000000:myNamespace MinimumTlsVersion : 1.2 Name : myNamespace PrincipalId : @@ -53,9 +53,9 @@ TenantId : Type : Microsoft.EventHub/Namespaces UpdatedAt : 11/17/2022 3:03:50 PM UserAssignedIdentity : { - "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity": { + "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity": { }, - "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity": { + "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity": { } } ZoneRedundant : True @@ -74,14 +74,14 @@ ClusterArmId : CreatedAt : 11/17/2022 3:14:09 PM DisableLocalAuth : False EnableAutoInflate : False -Id : /subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace +Id : /subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace IdentityType : SystemAssigned KafkaEnabled : True KeySource : KeyVaultProperty : Location : North Europe MaximumThroughputUnit : 0 -MetricId : {subscriptionId}:myNamespace +MetricId : 000000000000000:myNamespace MinimumTlsVersion : 1.2 Name : myNamespace PrincipalId : 000000000000000000 @@ -118,14 +118,14 @@ ClusterArmId : CreatedAt : 11/17/2022 3:14:09 PM DisableLocalAuth : True EnableAutoInflate : True -Id : /subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace +Id : /subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace IdentityType : KafkaEnabled : True KeySource : KeyVaultProperty : Location : South Central US MaximumThroughputUnit : 0 -MetricId : {subscriptionId}:myNamespace +MetricId : 000000000000000:myNamespace MinimumTlsVersion : 1.2 Name : myNamespace PrincipalId : 000000000000000000 diff --git a/src/EventHub/EventHub.Autorest/examples/Set-AzEventHubNamespaceV2.md b/src/EventHub/EventHub.Autorest/examples/Set-AzEventHubNamespaceV2.md index 9ff74721c291..4e23b46e77ca 100644 --- a/src/EventHub/EventHub.Autorest/examples/Set-AzEventHubNamespaceV2.md +++ b/src/EventHub/EventHub.Autorest/examples/Set-AzEventHubNamespaceV2.md @@ -4,7 +4,7 @@ $eventHubNamespace = Get-AzEventHubNamespaceV2 -ResourceGroupName myResourceGrou $identityId = $eventHubNamespace.UserAssignedIdentity.Keys -$identityId += "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity" +$identityId += "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity" Set-AzEventHubNamespaceV2 -InputObject $eventHubNamespace -UserAssignedIdentityId $identityId ``` @@ -15,35 +15,35 @@ ClusterArmId : CreatedAt : 11/17/2022 2:56:32 PM DisableLocalAuth : False EnableAutoInflate : False -Id : /subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace +Id : /subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace IdentityType : UserAssigned KafkaEnabled : True KeySource : Microsoft.KeyVault KeyVaultProperty : {{ "identity": { - "userAssignedIdentity": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" + "userAssignedIdentity": "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" }, "keyName": "key1", - "keyVaultUri": "https://{keyVaultName}.vault.azure.net/", + "keyVaultUri": "https://testkeyvault.vault.azure.net/", "keyVersion": "" }, { "identity": { - "userAssignedIdentity": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" + "userAssignedIdentity": "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" }, "keyName": "key2", - "keyVaultUri": "https://{keyVaultName}.vault.azure.net/", + "keyVaultUri": "https://testkeyvault.vault.azure.net/", "keyVersion": "" }, { "identity": { - "userAssignedIdentity": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" + "userAssignedIdentity": "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" }, "keyName": "key3", - "keyVaultUri": "https://{keyVaultName}.vault.azure.net/", + "keyVaultUri": "https://testkeyvault.vault.azure.net/", "keyVersion": "" }} Location : North Europe MaximumThroughputUnit : 0 -MetricId : {subscriptionId}:myNamespace +MetricId : 000000000000000:myNamespace MinimumTlsVersion : 1.2 Name : myNamespace PrincipalId : @@ -63,9 +63,9 @@ TenantId : Type : Microsoft.EventHub/Namespaces UpdatedAt : 11/17/2022 3:03:50 PM UserAssignedIdentity : { - "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity": { + "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity": { }, - "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity": { + "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity": { } } ZoneRedundant : True @@ -79,7 +79,7 @@ keys from the hashtable, which would result in an array of strings which can the ```powershell $eventHubNamespace = Get-AzEventHubNamespaceV2 -ResourceGroupName myResourceGroup -Name myNamespace -$newKeyVaultProperty = New-AzEventHubKeyVaultPropertiesObject -KeyName key3 -KeyVaultUri https://{keyVaultName}.vault.azure.net/ -UserAssignedIdentity "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" +$newKeyVaultProperty = New-AzEventHubKeyVaultPropertiesObject -KeyName key3 -KeyVaultUri https://testkeyvault.vault.azure.net -UserAssignedIdentity "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" $eventHubNamespace.KeyVaultProperty += $newKeyVaultProperty @@ -92,35 +92,35 @@ ClusterArmId : CreatedAt : 11/17/2022 2:56:32 PM DisableLocalAuth : False EnableAutoInflate : False -Id : /subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace +Id : /subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace IdentityType : UserAssigned KafkaEnabled : True KeySource : Microsoft.KeyVault KeyVaultProperty : {{ "identity": { - "userAssignedIdentity": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" + "userAssignedIdentity": "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" }, "keyName": "key1", - "keyVaultUri": "https://{keyVaultName}.vault.azure.net/", + "keyVaultUri": "https://testkeyvault.vault.azure.net", "keyVersion": "" }, { "identity": { - "userAssignedIdentity": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" + "userAssignedIdentity": "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" }, "keyName": "key2", - "keyVaultUri": "https://{keyVaultName}.vault.azure.net/", + "keyVaultUri": "https://testkeyvault.vault.azure.net", "keyVersion": "" }, { "identity": { - "userAssignedIdentity": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" + "userAssignedIdentity": "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" }, "keyName": "key3", - "keyVaultUri": "https://{keyVaultName}.vault.azure.net/", + "keyVaultUri": "https://testkeyvault.vault.azure.net", "keyVersion": "" }} Location : North Europe MaximumThroughputUnit : 0 -MetricId : {subscriptionId}:myNamespace +MetricId : 000000000000000:myNamespace MinimumTlsVersion : 1.2 Name : myNamespace PrincipalId : @@ -140,9 +140,9 @@ TenantId : Type : Microsoft.EventHub/Namespaces UpdatedAt : 11/17/2022 3:03:50 PM UserAssignedIdentity : { - "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity": { + "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity": { }, - "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity": { + "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity": { } } ZoneRedundant : True @@ -166,28 +166,28 @@ ClusterArmId : CreatedAt : 11/17/2022 2:56:32 PM DisableLocalAuth : False EnableAutoInflate : False -Id : /subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace +Id : /subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace IdentityType : UserAssigned KafkaEnabled : True KeySource : Microsoft.KeyVault KeyVaultProperty : {{ "identity": { - "userAssignedIdentity": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" + "userAssignedIdentity": "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" }, "keyName": "key1", - "keyVaultUri": "https://{keyVaultName}.vault.azure.net/", + "keyVaultUri": "https://testkeyvault.vault.azure.net", "keyVersion": "" }, { "identity": { - "userAssignedIdentity": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" + "userAssignedIdentity": "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" }, "keyName": "key2", - "keyVaultUri": "https://{keyVaultName}.vault.azure.net/", + "keyVaultUri": "https://testkeyvault.vault.azure.net", "keyVersion": "" }} Location : North Europe MaximumThroughputUnit : 0 -MetricId : {subscriptionId}:myNamespace +MetricId : 000000000000000:myNamespace MinimumTlsVersion : 1.2 Name : myNamespace PrincipalId : @@ -207,9 +207,9 @@ TenantId : Type : Microsoft.EventHub/Namespaces UpdatedAt : 11/17/2022 3:03:50 PM UserAssignedIdentity : { - "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity": { + "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity": { }, - "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity": { + "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity": { } } ZoneRedundant : True @@ -228,28 +228,28 @@ ClusterArmId : CreatedAt : 11/17/2022 2:56:32 PM DisableLocalAuth : False EnableAutoInflate : False -Id : /subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace +Id : /subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace IdentityType : UserAssigned KafkaEnabled : True KeySource : Microsoft.KeyVault KeyVaultProperty : {{ "identity": { - "userAssignedIdentity": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" + "userAssignedIdentity": "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" }, "keyName": "key1", - "keyVaultUri": "https://{keyVaultName}.vault.azure.net/", + "keyVaultUri": "https://testkeyvault.vault.azure.net", "keyVersion": "" }, { "identity": { - "userAssignedIdentity": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" + "userAssignedIdentity": "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" }, "keyName": "key2", - "keyVaultUri": "https://{keyVaultName}.vault.azure.net/", + "keyVaultUri": "https://testkeyvault.vault.azure.net", "keyVersion": "" }} Location : North Europe MaximumThroughputUnit : 0 -MetricId : {subscriptionId}:myNamespace +MetricId : 000000000000000:myNamespace MinimumTlsVersion : 1.2 Name : myNamespace PrincipalId : @@ -269,9 +269,9 @@ TenantId : Type : Microsoft.EventHub/Namespaces UpdatedAt : 11/17/2022 3:03:50 PM UserAssignedIdentity : { - "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity": { + "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity": { }, - "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity": { + "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity": { } } ZoneRedundant : True @@ -281,7 +281,7 @@ Sets `DisableLocalAuth` to true on an EventHub namespace `myNamespace`. ### Example 5: # Create a namespace with UserAssignedIdentity and use Set-Az cmdlet to set IdentityType to None. ```powershell -$eventHubNamespace = New-AzEventHubNamespaceV2 -ResourceGroupName myResourceGroup -Name myNamespace -SkuName Premium -Location northeurope -IdentityType UserAssigned -UserAssignedIdentityId "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" +$eventHubNamespace = New-AzEventHubNamespaceV2 -ResourceGroupName myResourceGroup -Name myNamespace -SkuName Premium -Location northeurope -IdentityType UserAssigned -UserAssignedIdentityId "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" $eventHubNamespace = Set-AzEventHubNamespaceV2 -ResourceGroupName myResourceGroup -Name myNamespace -IdentityType None -UserAssignedIdentityId:$null ``` @@ -291,7 +291,7 @@ ClusterArmId : CreatedAt : 11/21/2022 3:21:29 PM DisableLocalAuth : False EnableAutoInflate : False -Id : /subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/provide +Id : /subscriptions/000000000000000/resourceGroups/myResourceGroup/provide rs/Microsoft.EventHub/namespaces/myNamespace IdentityType : KafkaEnabled : True @@ -299,7 +299,7 @@ KeySource : KeyVaultProperty : Location : North Europe MaximumThroughputUnit : 0 -MetricId : {subscriptionId}:myNamespace +MetricId : 000000000000000:myNamespace MinimumTlsVersion : 1.2 Name : myNamespace PrincipalId : diff --git a/src/ServiceBus/ServiceBus.Autorest/custom/README.md b/src/ServiceBus/ServiceBus.Autorest/custom/README.md index d916a6785546..00bb8cc04eae 100644 --- a/src/ServiceBus/ServiceBus.Autorest/custom/README.md +++ b/src/ServiceBus/ServiceBus.Autorest/custom/README.md @@ -32,7 +32,7 @@ These provide functionality to our HTTP pipeline and other useful features. In s ### Attributes For processing the cmdlets, we've created some additional attributes: - `Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.DescriptionAttribute` - - Used in C# cmdlets to provide a high-level description of the cmdlet. This is propagated to reference documentation via [help comments](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comment_based_help) in the exported scripts. + - Used in C# cmdlets to provide a high-level description of the cmdlet. This is propagated to reference documentation via [help comments](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comment_based_help) in the exported scripts. - `Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.DoNotExportAttribute` - Used in C# and script cmdlets to suppress creating an exported cmdlet at build-time. These cmdlets will *not be exposed* by `Az.ServiceBus`. - `Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.InternalExportAttribute` diff --git a/src/ServiceBus/ServiceBus.Autorest/docs/Get-AzServiceBusNamespaceV2.md b/src/ServiceBus/ServiceBus.Autorest/docs/Get-AzServiceBusNamespaceV2.md index 457df6b3e692..4c9cc37caee1 100644 --- a/src/ServiceBus/ServiceBus.Autorest/docs/Get-AzServiceBusNamespaceV2.md +++ b/src/ServiceBus/ServiceBus.Autorest/docs/Get-AzServiceBusNamespaceV2.md @@ -49,20 +49,20 @@ $namespace = Get-AzServiceBusNamespaceV2 -ResourceGroupName myResourceGroup -Nam AlternateName : CreatedAt : 11/22/2022 4:15:58 PM DisableLocalAuth : False -Id : /subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace +Id : /subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace IdentityType : UserAssigned KeySource : Microsoft.KeyVault KeyVaultProperty : {{ "identity": { - "userAssignedIdentity": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/use + "userAssignedIdentity": "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/use rAssignedIdentities/myFirstIdentity" }, "keyName": "key4", - "keyVaultUri": "https://keyVaultName.vault.azure.net", + "keyVaultUri": "https://testkeyvault.vault.azure.net", "keyVersion": "" }} Location : East US -MetricId : {subscriptionId}:myNamespace +MetricId : 000000000000000:myNamespace MinimumTlsVersion : 1.2 Name : myNamespace PrincipalId : @@ -88,13 +88,13 @@ TenantId : Type : Microsoft.ServiceBus/Namespaces UpdatedAt : 11/23/2022 7:14:58 AM UserAssignedIdentity : { - "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity + "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity /userAssignedIdentities/myThirdIdentity": { }, - "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity + "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity /userAssignedIdentities/mySecondIdentity": { }, - "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity + "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity /userAssignedIdentities/myFirstIdentity": { } } @@ -112,7 +112,7 @@ Lists all ServiceBus namespaces under resource group `myResourceGroup`. ### Example 3: List all ServiceBus namespaces in a subscription ```powershell -Get-AzEventHubNamespaceV2 +Get-AzServiceBusNamespaceV2 ``` Lists all ServiceBus namespaces in the current subscription context. diff --git a/src/ServiceBus/ServiceBus.Autorest/docs/New-AzServiceBusGeoDRConfiguration.md b/src/ServiceBus/ServiceBus.Autorest/docs/New-AzServiceBusGeoDRConfiguration.md index 3d959c5413cf..67134343cffd 100644 --- a/src/ServiceBus/ServiceBus.Autorest/docs/New-AzServiceBusGeoDRConfiguration.md +++ b/src/ServiceBus/ServiceBus.Autorest/docs/New-AzServiceBusGeoDRConfiguration.md @@ -25,16 +25,16 @@ Creates or updates a new Alias(Disaster Recovery configuration) ### Example 1: Create a disaster recovery Alias ```powershell -New-AzServiceBusGeoDRConfiguration -Name myAlias -ResourceGroupName myResourceGroup -NamespaceName myPrimaryNamespace -PartnerNamespace /subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/mySecondaryNamespace +New-AzServiceBusGeoDRConfiguration -Name myAlias -ResourceGroupName myResourceGroup -NamespaceName myPrimaryNamespace -PartnerNamespace "/subscriptions/0000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/mySecondaryNamespace" ``` ```output AlternateName : -Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myPrimaryNamespace/disasterRecoveryCon +Id : /subscriptions/0000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myPrimaryNamespace/disasterRecoveryCon figs/myAlias Location : Name : myAlias -PartnerNamespace : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/mySecondaryNamespace +PartnerNamespace : /subscriptions/0000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/mySecondaryNamespace PendingReplicationOperationsCount : ProvisioningState : Succeeded ResourceGroupName : myResourceGroup diff --git a/src/ServiceBus/ServiceBus.Autorest/docs/New-AzServiceBusKeyVaultPropertiesObject.md b/src/ServiceBus/ServiceBus.Autorest/docs/New-AzServiceBusKeyVaultPropertiesObject.md index 9f71bd8aab4b..6dce97c908a3 100644 --- a/src/ServiceBus/ServiceBus.Autorest/docs/New-AzServiceBusKeyVaultPropertiesObject.md +++ b/src/ServiceBus/ServiceBus.Autorest/docs/New-AzServiceBusKeyVaultPropertiesObject.md @@ -24,13 +24,13 @@ Create an in-memory object for KeyVaultProperties. ### Example 1: Construct an in-memory KeyVaultProperties object ```powershell -New-AzServiceBusKeyVaultPropertiesObject -KeyName key1 -KeyVaultUri https://{keyVaultName}.vault.azure.net/ +New-AzServiceBusKeyVaultPropertiesObject -KeyName key1 -KeyVaultUri https://testkeyvault.vault.azure.net/ ``` ```Output KeyName KeyVaultUri KeyVersion UserAssignedIdentity ------- ----------- ---------- -------------------- -key4 https://{keyVaultName}.vault.azure.net/ +key4 https://testkeyvault.vault.azure.net/ ``` Creates an in-memory object of type `IKeyVaultProperties`. An array of `IKeyVaultProperties` can be fed as @@ -38,14 +38,14 @@ input to `KeyVaultProperty` parameter of New-AzServiceBusNamespaceV2 and Set-AzS ### Example 2: Construct an in-memory KeyVaultProperties object having UserassignedIdentity ```powershell -$ec1 = "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" -New-AzServiceBusKeyVaultPropertiesObject -KeyName key4 -KeyVaultUri https://{keyVaultName}.vault.azure.net/ -UserAssignedIdentity $ec1 +$ec1 = "/subscriptions/0000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" +New-AzServiceBusKeyVaultPropertiesObject -KeyName key4 -KeyVaultUri https://testkeyvault.vault.azure.net/ -UserAssignedIdentity $ec1 ``` ```Output KeyName KeyVaultUri KeyVersion UserAssignedIdentity ------- ----------- ---------- -------------------- -key4 https://{keyVaultName}.vault.azure.net/ /subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity +key4 https://testkeyvault.vault.azure.net/ /subscriptions/0000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity ``` Creates an in-memory object of type `IKeyVaultProperties`. An array of `IKeyVaultProperties` can be fed as diff --git a/src/ServiceBus/ServiceBus.Autorest/docs/New-AzServiceBusNamespaceV2.md b/src/ServiceBus/ServiceBus.Autorest/docs/New-AzServiceBusNamespaceV2.md index 75dff32f9562..d0218083545b 100644 --- a/src/ServiceBus/ServiceBus.Autorest/docs/New-AzServiceBusNamespaceV2.md +++ b/src/ServiceBus/ServiceBus.Autorest/docs/New-AzServiceBusNamespaceV2.md @@ -28,10 +28,10 @@ Creates a new ServiceBus namespace. ### Example 1: Create a new ServiceBus namespace with UserAssignedIdentity Encryption ```powershell -$id1 = "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" -$id2 = "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity" -$keyVaultProperty1 = New-AzServiceBusKeyVaultPropertiesObject -KeyName key4 -KeyVaultUri https://{keyVaultName}.vault.azure.net/ -UserAssignedIdentity "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" -$keyVaultProperty2 = New-AzServiceBusKeyVaultPropertiesObject -KeyName key5 -KeyVaultUri https://{keyVaultName}.vault.azure.net/ -UserAssignedIdentity "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" +$id1 = "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" +$id2 = "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity" +$keyVaultProperty1 = New-AzServiceBusKeyVaultPropertiesObject -KeyName key4 -KeyVaultUri https://testkeyvault.vault.azure.net/ -UserAssignedIdentity "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" +$keyVaultProperty2 = New-AzServiceBusKeyVaultPropertiesObject -KeyName key5 -KeyVaultUri https://testkeyvault.vault.azure.net/ -UserAssignedIdentity "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" New-AzServiceBusNamespaceV2 -ResourceGroupName myResourceGroup -Name myNamespace -SkuName Premium -Location northeurope -IdentityType UserAssigned -UserAssignedIdentityID $id1,$id2 -KeyVaultProperty $keyVaultProperty1,$keyVaultProperty2 ``` @@ -39,31 +39,31 @@ New-AzServiceBusNamespaceV2 -ResourceGroupName myResourceGroup -Name myNamespace AlternateName : CreatedAt : 11/21/2022 5:15:41 AM DisableLocalAuth : False -Id : /subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/provide +Id : /subscriptions/000000000000000/resourceGroups/myResourceGroup/provide rs/Microsoft.ServiceBus/namespaces/myNamespace IdentityType : UserAssigned KeySource : Microsoft.KeyVault KeyVaultProperty : {{ "identity": { - "userAssignedIdentity": "/subscriptions/{subscriptionId}/reso + "userAssignedIdentity": "/subscriptions/000000000000000/reso urceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity " }, "keyName": "key4", - "keyVaultUri": "https://keyVaultName.vault.azure.net", + "keyVaultUri": "https://testkeyvault.vault.azure.net", "keyVersion": "" }, { "identity": { - "userAssignedIdentity": "/subscriptions/{subscriptionId}/reso + "userAssignedIdentity": "/subscriptions/000000000000000/reso urceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity " }, "keyName": "key5", - "keyVaultUri": "https://keyVaultName.vault.azure.net", + "keyVaultUri": "https://testkeyvault.vault.azure.net", "keyVersion": "" }} Location : North Europe -MetricId : {subscriptionId}:myNamespace +MetricId : 000000000000000:myNamespace MinimumTlsVersion : 1.2 Name : myNamespace PrincipalId : @@ -89,10 +89,10 @@ TenantId : Type : Microsoft.ServiceBus/Namespaces UpdatedAt : 11/21/2022 5:23:01 AM UserAssignedIdentity : { - "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/prov + "/subscriptions/000000000000000/resourceGroups/myResourceGroup/prov iders/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity": { }, - "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/prov + "/subscriptions/000000000000000/resourceGroups/myResourceGroup/prov iders/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity": { } } @@ -110,13 +110,13 @@ New-AzServiceBusNamespaceV2 -ResourceGroupName myResourceGroup -Name myNamespace AlternateName : CreatedAt : 11/21/2022 5:33:10 AM DisableLocalAuth : False -Id : /subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/provide +Id : /subscriptions/000000000000000/resourceGroups/myResourceGroup/provide rs/Microsoft.ServiceBus/namespaces/myNamespace IdentityType : SystemAssigned KeySource : KeyVaultProperty : Location : North Europe -MetricId : {subscriptionId}:myNamespace +MetricId : 000000000000000:myNamespace MinimumTlsVersion : 1.2 Name : myNamespace PrincipalId : 000000000000 @@ -157,12 +157,12 @@ New-AzEventHubNamespaceV2 -ResourceGroupName myResourceGroup -Name myNamespace - AlternateName : CreatedAt : 11/18/2022 6:06:22 AM DisableLocalAuth : True -Id : /subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace +Id : /subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace IdentityType : KeySource : KeyVaultProperty : Location : South Central US -MetricId : {subscriptionId}:myNamespace +MetricId : 000000000000000:myNamespace MinimumTlsVersion : 1.1 Name : myNamespace PrincipalId : diff --git a/src/ServiceBus/ServiceBus.Autorest/docs/README.md b/src/ServiceBus/ServiceBus.Autorest/docs/README.md index c2584954b353..d3f57a307309 100644 --- a/src/ServiceBus/ServiceBus.Autorest/docs/README.md +++ b/src/ServiceBus/ServiceBus.Autorest/docs/README.md @@ -8,4 +8,4 @@ This directory contains the documentation of the cmdlets for the `Az.ServiceBus` - Packaged: yes ## Details -The process of documentation generation loads `Az.ServiceBus` and analyzes the exported cmdlets from the module. It recognizes the [help comments](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comment_based_help) that are generated into the scripts in the `../exports` folder. Additionally, when writing custom cmdlets in the `../custom` folder, you can use the help comments syntax, which decorate the exported scripts at build-time. The documentation examples are taken from the `../examples` folder. \ No newline at end of file +The process of documentation generation loads `Az.ServiceBus` and analyzes the exported cmdlets from the module. It recognizes the [help comments](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comment_based_help) that are generated into the scripts in the `../exports` folder. Additionally, when writing custom cmdlets in the `../custom` folder, you can use the help comments syntax, which decorate the exported scripts at build-time. The documentation examples are taken from the `../examples` folder. \ No newline at end of file diff --git a/src/ServiceBus/ServiceBus.Autorest/docs/Set-AzServiceBusNamespaceV2.md b/src/ServiceBus/ServiceBus.Autorest/docs/Set-AzServiceBusNamespaceV2.md index 8cb270fd9f15..da21ba37dd51 100644 --- a/src/ServiceBus/ServiceBus.Autorest/docs/Set-AzServiceBusNamespaceV2.md +++ b/src/ServiceBus/ServiceBus.Autorest/docs/Set-AzServiceBusNamespaceV2.md @@ -39,7 +39,7 @@ Updates a ServiceBus namespace ### Example 1: Add a KeyVaultProperty to an existing ServiceBus Namespace ```powershell $serviceBusNamespace = Get-AzServiceBusNamespaceV2 -ResourceGroupName myResourceGroup -NamespaceName myNamespace -$newKeyVaultProperty = New-AzServiceBusKeyVaultPropertiesObject -KeyName key6 -KeyVaultUri https://{keyVaultName}.vault.azure.net/ -UserAssignedIdentity "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" +$newKeyVaultProperty = New-AzServiceBusKeyVaultPropertiesObject -KeyName key6 -KeyVaultUri https://testkeyvault.vault.azure.net -UserAssignedIdentity "/subscriptions/000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" $serviceBusNamespace.KeyVaultProperty += $newKeyVaultProperty Set-AzEventHubNamespaceV2 -InputObject $serviceBusNamespace -KeyVaultProperty $serviceBusNamespace.KeyVaultProperty ``` @@ -48,36 +48,36 @@ Set-AzEventHubNamespaceV2 -InputObject $serviceBusNamespace -KeyVaultProperty $s AlternateName : CreatedAt : 11/17/2022 5:51:52 AM DisableLocalAuth : False -Id : /subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace +Id : /subscriptions/000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace IdentityType : KeySource : KeyVaultProperty : {{ "identity": { - "userAssignedIdentity": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/use + "userAssignedIdentity": "/subscriptions/000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/use rAssignedIdentities/myFirstIdentity" }, "keyName": "key4", - "keyVaultUri": "https://{KeyVaultName}.vault.azure.net", + "keyVaultUri": "https://testkeyvault.vault.azure.net", "keyVersion": "" }, { "identity": { - "userAssignedIdentity": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/use + "userAssignedIdentity": "/subscriptions/000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/use rAssignedIdentities/myFirstIdentity" }, "keyName": "key5", - "keyVaultUri": "https://{KeyVaultName}.vault.azure.net", + "keyVaultUri": "https://testkeyvault.vault.azure.net", "keyVersion": "" }, { "identity": { - "userAssignedIdentity": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/use + "userAssignedIdentity": "/subscriptions/000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/use rAssignedIdentities/myFirstIdentity" }, "keyName": "key6", - "keyVaultUri": "https://{KeyVaultName}.vault.azure.net", + "keyVaultUri": "https://testkeyvault.vault.azure.net", "keyVersion": "" }} Location : North Europe -MetricId : {subscriptionId}:myNamespace +MetricId : 000000000000:myNamespace MinimumTlsVersion : 1.1 Name : myNamespace PrincipalId : @@ -120,28 +120,28 @@ Set-AzServiceBusNamespaceV2 -InputObject $serviceBusNamespace -KeyVaultProperty AlternateName : CreatedAt : 11/21/2022 5:15:41 AM DisableLocalAuth : False -Id : /subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace +Id : /subscriptions/000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace IdentityType : UserAssigned KeySource : Microsoft.KeyVault KeyVaultProperty : {{ "identity": { - "userAssignedIdentity": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/ + "userAssignedIdentity": "/subscriptions/000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/ userAssignedIdentities/myFirstIdentity" }, "keyName": "key4", - "keyVaultUri": "https://{keyVaultName}.vault.azure.net", + "keyVaultUri": "https://testkeyvault.vault.azure.net", "keyVersion": "" }, { "identity": { - "userAssignedIdentity": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/ + "userAssignedIdentity": "/subscriptions/000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/ userAssignedIdentities/myFirstIdentity" }, "keyName": "key6", - "keyVaultUri": "https://{keyVaultName}.vault.azure.net", + "keyVaultUri": "https://testkeyvault.vault.azure.net", "keyVersion": "" }} Location : North Europe -MetricId : {subscriptionId}:myNamespace +MetricId : 000000000000:myNamespace MinimumTlsVersion : 1.2 Name : myNamespace PrincipalId : @@ -167,10 +167,10 @@ TenantId : Type : Microsoft.ServiceBus/Namespaces UpdatedAt : 11/21/2022 8:52:02 AM UserAssignedIdentity : { - "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/ + "/subscriptions/000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/ userAssignedIdentities/myFirstIdentity": { }, - "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/ + "/subscriptions/000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/ userAssignedIdentities/mySecondIdentity": { } } @@ -182,8 +182,8 @@ Remove the second KeyVaultProperty from the list of KeyVaultProperties. ### Example 3: Add UserAssigned Identity to Namespace with IdentityType SystemAssigned to test for SystemAssigned and UserAssigned ```powershell $serviceBusNamespace = Get-AzServiceBusNamespaceV2 -ResourceGroupName myResourceGroup -NamespaceName myNamespace -$id1 = "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" -$id2 = "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity" +$id1 = "/subscriptions/000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" +$id2 = "/subscriptions/000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity" Set-AzServiceBusNamespaceV2 -InputObject $serviceBusNamespace -IdentityType "SystemAssigned, UserAssigned" -UserAssignedIdentityId $id1, $id2 ``` @@ -191,12 +191,12 @@ Set-AzServiceBusNamespaceV2 -InputObject $serviceBusNamespace -IdentityType "Sys AlternateName : CreatedAt : 11/17/2022 3:54:50 AM DisableLocalAuth : False -Id : /subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace +Id : /subscriptions/000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace IdentityType : SystemAssigned, UserAssigned KeySource : KeyVaultProperty : Location : North Europe -MetricId : {subscriptionId}:myNamespace +MetricId : 000000000000:myNamespace MinimumTlsVersion : 1.2 Name : myNamespace PrincipalId : 000000000000000 @@ -222,10 +222,10 @@ TenantId : 0000000000000000 Type : Microsoft.ServiceBus/Namespaces UpdatedAt : 11/21/2022 9:15:53 AM UserAssignedIdentity : { - "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/ + "/subscriptions/000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/ userAssignedIdentities/mySecondIdentity": { }, - "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/ + "/subscriptions/000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/ userAssignedIdentities/myFirstIdentity": { } } @@ -236,8 +236,8 @@ Added UserAssigned Identity to Namespace with IdentityType SystemAssigned to tes ### Example 4: # Create a namespace with UserAssignedIdentity and use Set-Az cmdlet to set IdentityType to None. ```powershell -$id1 = "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" -$id2 = "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity" +$id1 = "/subscriptions/000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" +$id2 = "/subscriptions/000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity" $serviceBusNamespace = New-AzServiceBusNamespaceV2 -ResourceGroupName myResourceGroup -Name myNamespace -SkuName Premium -Location northeurope -IdentityType UserAssigned -UserAssignedIdentityId $id1,$id2 $serviceBusNamespace = Set-AzServiceBusNamespaceV2 -ResourceGroupName myResourceGroup -Name myNamespace -IdentityType None -UserAssignedIdentityId:$null ``` @@ -246,13 +246,13 @@ $serviceBusNamespace = Set-AzServiceBusNamespaceV2 -ResourceGroupName myResource AlternateName : CreatedAt : 11/17/2022 3:54:50 AM DisableLocalAuth : False -Id : /subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/M +Id : /subscriptions/000000000000/resourceGroups/myResourceGroup/providers/M icrosoft.ServiceBus/namespaces/myNamespace IdentityType : KeySource : KeyVaultProperty : Location : North Europe -MetricId : {subscriptionId}:myNamespace +MetricId : 000000000000:myNamespace MinimumTlsVersion : 1.2 Name : myNamespace PrincipalId : diff --git a/src/ServiceBus/ServiceBus.Autorest/examples/Get-AzServiceBusNamespaceV2.md b/src/ServiceBus/ServiceBus.Autorest/examples/Get-AzServiceBusNamespaceV2.md index 8e0fba75edce..f0e54b628d67 100644 --- a/src/ServiceBus/ServiceBus.Autorest/examples/Get-AzServiceBusNamespaceV2.md +++ b/src/ServiceBus/ServiceBus.Autorest/examples/Get-AzServiceBusNamespaceV2.md @@ -7,20 +7,20 @@ $namespace = Get-AzServiceBusNamespaceV2 -ResourceGroupName myResourceGroup -Nam AlternateName : CreatedAt : 11/22/2022 4:15:58 PM DisableLocalAuth : False -Id : /subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace +Id : /subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace IdentityType : UserAssigned KeySource : Microsoft.KeyVault KeyVaultProperty : {{ "identity": { - "userAssignedIdentity": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/use + "userAssignedIdentity": "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/use rAssignedIdentities/myFirstIdentity" }, "keyName": "key4", - "keyVaultUri": "https://keyVaultName.vault.azure.net", + "keyVaultUri": "https://testkeyvault.vault.azure.net", "keyVersion": "" }} Location : East US -MetricId : {subscriptionId}:myNamespace +MetricId : 000000000000000:myNamespace MinimumTlsVersion : 1.2 Name : myNamespace PrincipalId : @@ -46,13 +46,13 @@ TenantId : Type : Microsoft.ServiceBus/Namespaces UpdatedAt : 11/23/2022 7:14:58 AM UserAssignedIdentity : { - "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity + "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity /userAssignedIdentities/myThirdIdentity": { }, - "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity + "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity /userAssignedIdentities/mySecondIdentity": { }, - "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity + "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity /userAssignedIdentities/myFirstIdentity": { } } @@ -69,7 +69,7 @@ Lists all ServiceBus namespaces under resource group `myResourceGroup`. ### Example 3: List all ServiceBus namespaces in a subscription ```powershell -Get-AzEventHubNamespaceV2 +Get-AzServiceBusNamespaceV2 ``` Lists all ServiceBus namespaces in the current subscription context. diff --git a/src/ServiceBus/ServiceBus.Autorest/examples/New-AzServiceBusGeoDRConfiguration.md b/src/ServiceBus/ServiceBus.Autorest/examples/New-AzServiceBusGeoDRConfiguration.md index 50223575d64d..dda459734ef5 100644 --- a/src/ServiceBus/ServiceBus.Autorest/examples/New-AzServiceBusGeoDRConfiguration.md +++ b/src/ServiceBus/ServiceBus.Autorest/examples/New-AzServiceBusGeoDRConfiguration.md @@ -1,15 +1,15 @@ ### Example 1: Create a disaster recovery Alias ```powershell -New-AzServiceBusGeoDRConfiguration -Name myAlias -ResourceGroupName myResourceGroup -NamespaceName myPrimaryNamespace -PartnerNamespace /subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/mySecondaryNamespace +New-AzServiceBusGeoDRConfiguration -Name myAlias -ResourceGroupName myResourceGroup -NamespaceName myPrimaryNamespace -PartnerNamespace "/subscriptions/0000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/mySecondaryNamespace" ``` ```output AlternateName : -Id : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myPrimaryNamespace/disasterRecoveryCon +Id : /subscriptions/0000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myPrimaryNamespace/disasterRecoveryCon figs/myAlias Location : Name : myAlias -PartnerNamespace : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/mySecondaryNamespace +PartnerNamespace : /subscriptions/0000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/mySecondaryNamespace PendingReplicationOperationsCount : ProvisioningState : Succeeded ResourceGroupName : myResourceGroup diff --git a/src/ServiceBus/ServiceBus.Autorest/examples/New-AzServiceBusKeyVaultPropertiesObject.md b/src/ServiceBus/ServiceBus.Autorest/examples/New-AzServiceBusKeyVaultPropertiesObject.md index 9105496651ac..60da8bbd6356 100644 --- a/src/ServiceBus/ServiceBus.Autorest/examples/New-AzServiceBusKeyVaultPropertiesObject.md +++ b/src/ServiceBus/ServiceBus.Autorest/examples/New-AzServiceBusKeyVaultPropertiesObject.md @@ -1,24 +1,24 @@ ### Example 1: Construct an in-memory KeyVaultProperties object ```powershell -New-AzServiceBusKeyVaultPropertiesObject -KeyName key1 -KeyVaultUri https://{keyVaultName}.vault.azure.net/ +New-AzServiceBusKeyVaultPropertiesObject -KeyName key1 -KeyVaultUri https://testkeyvault.vault.azure.net/ ``` ```Output KeyName KeyVaultUri KeyVersion UserAssignedIdentity ------- ----------- ---------- -------------------- -key4 https://{keyVaultName}.vault.azure.net/ +key4 https://testkeyvault.vault.azure.net/ ``` Creates an in-memory object of type `IKeyVaultProperties`. An array of `IKeyVaultProperties` can be fed as input to `KeyVaultProperty` parameter of New-AzServiceBusNamespaceV2 and Set-AzServiceBusNamespaceV2 to enable encryption. ### Example 2: Construct an in-memory KeyVaultProperties object having UserassignedIdentity ```powershell -$ec1 = "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" -New-AzServiceBusKeyVaultPropertiesObject -KeyName key4 -KeyVaultUri https://{keyVaultName}.vault.azure.net/ -UserAssignedIdentity $ec1 +$ec1 = "/subscriptions/0000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" +New-AzServiceBusKeyVaultPropertiesObject -KeyName key4 -KeyVaultUri https://testkeyvault.vault.azure.net/ -UserAssignedIdentity $ec1 ``` ```Output KeyName KeyVaultUri KeyVersion UserAssignedIdentity ------- ----------- ---------- -------------------- -key4 https://{keyVaultName}.vault.azure.net/ /subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity +key4 https://testkeyvault.vault.azure.net/ /subscriptions/0000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity ``` Creates an in-memory object of type `IKeyVaultProperties`. An array of `IKeyVaultProperties` can be fed as input to `KeyVaultProperty` parameter of New-AzServiceBusNamespaceV2 and Set-AzServiceBusNamespaceV2 to enable encryption. diff --git a/src/ServiceBus/ServiceBus.Autorest/examples/New-AzServiceBusNamespaceV2.md b/src/ServiceBus/ServiceBus.Autorest/examples/New-AzServiceBusNamespaceV2.md index d5be00875c90..26ee5d37e245 100644 --- a/src/ServiceBus/ServiceBus.Autorest/examples/New-AzServiceBusNamespaceV2.md +++ b/src/ServiceBus/ServiceBus.Autorest/examples/New-AzServiceBusNamespaceV2.md @@ -1,9 +1,9 @@ ### Example 1: Create a new ServiceBus namespace with UserAssignedIdentity Encryption ```powershell -$id1 = "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" -$id2 = "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity" -$keyVaultProperty1 = New-AzServiceBusKeyVaultPropertiesObject -KeyName key4 -KeyVaultUri https://{keyVaultName}.vault.azure.net/ -UserAssignedIdentity "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" -$keyVaultProperty2 = New-AzServiceBusKeyVaultPropertiesObject -KeyName key5 -KeyVaultUri https://{keyVaultName}.vault.azure.net/ -UserAssignedIdentity "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" +$id1 = "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" +$id2 = "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity" +$keyVaultProperty1 = New-AzServiceBusKeyVaultPropertiesObject -KeyName key4 -KeyVaultUri https://testkeyvault.vault.azure.net/ -UserAssignedIdentity "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" +$keyVaultProperty2 = New-AzServiceBusKeyVaultPropertiesObject -KeyName key5 -KeyVaultUri https://testkeyvault.vault.azure.net/ -UserAssignedIdentity "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" New-AzServiceBusNamespaceV2 -ResourceGroupName myResourceGroup -Name myNamespace -SkuName Premium -Location northeurope -IdentityType UserAssigned -UserAssignedIdentityID $id1,$id2 -KeyVaultProperty $keyVaultProperty1,$keyVaultProperty2 ``` @@ -11,31 +11,31 @@ New-AzServiceBusNamespaceV2 -ResourceGroupName myResourceGroup -Name myNamespace AlternateName : CreatedAt : 11/21/2022 5:15:41 AM DisableLocalAuth : False -Id : /subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/provide +Id : /subscriptions/000000000000000/resourceGroups/myResourceGroup/provide rs/Microsoft.ServiceBus/namespaces/myNamespace IdentityType : UserAssigned KeySource : Microsoft.KeyVault KeyVaultProperty : {{ "identity": { - "userAssignedIdentity": "/subscriptions/{subscriptionId}/reso + "userAssignedIdentity": "/subscriptions/000000000000000/reso urceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity " }, "keyName": "key4", - "keyVaultUri": "https://keyVaultName.vault.azure.net", + "keyVaultUri": "https://testkeyvault.vault.azure.net", "keyVersion": "" }, { "identity": { - "userAssignedIdentity": "/subscriptions/{subscriptionId}/reso + "userAssignedIdentity": "/subscriptions/000000000000000/reso urceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity " }, "keyName": "key5", - "keyVaultUri": "https://keyVaultName.vault.azure.net", + "keyVaultUri": "https://testkeyvault.vault.azure.net", "keyVersion": "" }} Location : North Europe -MetricId : {subscriptionId}:myNamespace +MetricId : 000000000000000:myNamespace MinimumTlsVersion : 1.2 Name : myNamespace PrincipalId : @@ -61,10 +61,10 @@ TenantId : Type : Microsoft.ServiceBus/Namespaces UpdatedAt : 11/21/2022 5:23:01 AM UserAssignedIdentity : { - "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/prov + "/subscriptions/000000000000000/resourceGroups/myResourceGroup/prov iders/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity": { }, - "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/prov + "/subscriptions/000000000000000/resourceGroups/myResourceGroup/prov iders/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity": { } } @@ -83,13 +83,13 @@ New-AzServiceBusNamespaceV2 -ResourceGroupName myResourceGroup -Name myNamespace AlternateName : CreatedAt : 11/21/2022 5:33:10 AM DisableLocalAuth : False -Id : /subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/provide +Id : /subscriptions/000000000000000/resourceGroups/myResourceGroup/provide rs/Microsoft.ServiceBus/namespaces/myNamespace IdentityType : SystemAssigned KeySource : KeyVaultProperty : Location : North Europe -MetricId : {subscriptionId}:myNamespace +MetricId : 000000000000000:myNamespace MinimumTlsVersion : 1.2 Name : myNamespace PrincipalId : 000000000000 @@ -130,12 +130,12 @@ New-AzEventHubNamespaceV2 -ResourceGroupName myResourceGroup -Name myNamespace - AlternateName : CreatedAt : 11/18/2022 6:06:22 AM DisableLocalAuth : True -Id : /subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace +Id : /subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace IdentityType : KeySource : KeyVaultProperty : Location : South Central US -MetricId : {subscriptionId}:myNamespace +MetricId : 000000000000000:myNamespace MinimumTlsVersion : 1.1 Name : myNamespace PrincipalId : diff --git a/src/ServiceBus/ServiceBus.Autorest/examples/Set-AzServiceBusNamespaceV2.md b/src/ServiceBus/ServiceBus.Autorest/examples/Set-AzServiceBusNamespaceV2.md index 3e733c44d546..e2722f6125b4 100644 --- a/src/ServiceBus/ServiceBus.Autorest/examples/Set-AzServiceBusNamespaceV2.md +++ b/src/ServiceBus/ServiceBus.Autorest/examples/Set-AzServiceBusNamespaceV2.md @@ -1,7 +1,7 @@ ### Example 1: Add a KeyVaultProperty to an existing ServiceBus Namespace ```powershell $serviceBusNamespace = Get-AzServiceBusNamespaceV2 -ResourceGroupName myResourceGroup -NamespaceName myNamespace -$newKeyVaultProperty = New-AzServiceBusKeyVaultPropertiesObject -KeyName key6 -KeyVaultUri https://{keyVaultName}.vault.azure.net/ -UserAssignedIdentity "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" +$newKeyVaultProperty = New-AzServiceBusKeyVaultPropertiesObject -KeyName key6 -KeyVaultUri https://testkeyvault.vault.azure.net -UserAssignedIdentity "/subscriptions/000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" $serviceBusNamespace.KeyVaultProperty += $newKeyVaultProperty Set-AzEventHubNamespaceV2 -InputObject $serviceBusNamespace -KeyVaultProperty $serviceBusNamespace.KeyVaultProperty ``` @@ -10,36 +10,36 @@ Set-AzEventHubNamespaceV2 -InputObject $serviceBusNamespace -KeyVaultProperty $s AlternateName : CreatedAt : 11/17/2022 5:51:52 AM DisableLocalAuth : False -Id : /subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace +Id : /subscriptions/000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace IdentityType : KeySource : KeyVaultProperty : {{ "identity": { - "userAssignedIdentity": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/use + "userAssignedIdentity": "/subscriptions/000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/use rAssignedIdentities/myFirstIdentity" }, "keyName": "key4", - "keyVaultUri": "https://{KeyVaultName}.vault.azure.net", + "keyVaultUri": "https://testkeyvault.vault.azure.net", "keyVersion": "" }, { "identity": { - "userAssignedIdentity": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/use + "userAssignedIdentity": "/subscriptions/000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/use rAssignedIdentities/myFirstIdentity" }, "keyName": "key5", - "keyVaultUri": "https://{KeyVaultName}.vault.azure.net", + "keyVaultUri": "https://testkeyvault.vault.azure.net", "keyVersion": "" }, { "identity": { - "userAssignedIdentity": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/use + "userAssignedIdentity": "/subscriptions/000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/use rAssignedIdentities/myFirstIdentity" }, "keyName": "key6", - "keyVaultUri": "https://{KeyVaultName}.vault.azure.net", + "keyVaultUri": "https://testkeyvault.vault.azure.net", "keyVersion": "" }} Location : North Europe -MetricId : {subscriptionId}:myNamespace +MetricId : 000000000000:myNamespace MinimumTlsVersion : 1.1 Name : myNamespace PrincipalId : @@ -83,28 +83,28 @@ Set-AzServiceBusNamespaceV2 -InputObject $serviceBusNamespace -KeyVaultProperty AlternateName : CreatedAt : 11/21/2022 5:15:41 AM DisableLocalAuth : False -Id : /subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace +Id : /subscriptions/000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace IdentityType : UserAssigned KeySource : Microsoft.KeyVault KeyVaultProperty : {{ "identity": { - "userAssignedIdentity": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/ + "userAssignedIdentity": "/subscriptions/000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/ userAssignedIdentities/myFirstIdentity" }, "keyName": "key4", - "keyVaultUri": "https://{keyVaultName}.vault.azure.net", + "keyVaultUri": "https://testkeyvault.vault.azure.net", "keyVersion": "" }, { "identity": { - "userAssignedIdentity": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/ + "userAssignedIdentity": "/subscriptions/000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/ userAssignedIdentities/myFirstIdentity" }, "keyName": "key6", - "keyVaultUri": "https://{keyVaultName}.vault.azure.net", + "keyVaultUri": "https://testkeyvault.vault.azure.net", "keyVersion": "" }} Location : North Europe -MetricId : {subscriptionId}:myNamespace +MetricId : 000000000000:myNamespace MinimumTlsVersion : 1.2 Name : myNamespace PrincipalId : @@ -130,10 +130,10 @@ TenantId : Type : Microsoft.ServiceBus/Namespaces UpdatedAt : 11/21/2022 8:52:02 AM UserAssignedIdentity : { - "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/ + "/subscriptions/000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/ userAssignedIdentities/myFirstIdentity": { }, - "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/ + "/subscriptions/000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/ userAssignedIdentities/mySecondIdentity": { } } @@ -146,8 +146,8 @@ Remove the second KeyVaultProperty from the list of KeyVaultProperties. ### Example 3: Add UserAssigned Identity to Namespace with IdentityType SystemAssigned to test for SystemAssigned and UserAssigned ```powershell $serviceBusNamespace = Get-AzServiceBusNamespaceV2 -ResourceGroupName myResourceGroup -NamespaceName myNamespace -$id1 = "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" -$id2 = "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity" +$id1 = "/subscriptions/000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" +$id2 = "/subscriptions/000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity" Set-AzServiceBusNamespaceV2 -InputObject $serviceBusNamespace -IdentityType "SystemAssigned, UserAssigned" -UserAssignedIdentityId $id1, $id2 ``` @@ -155,12 +155,12 @@ Set-AzServiceBusNamespaceV2 -InputObject $serviceBusNamespace -IdentityType "Sys AlternateName : CreatedAt : 11/17/2022 3:54:50 AM DisableLocalAuth : False -Id : /subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace +Id : /subscriptions/000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/myNamespace IdentityType : SystemAssigned, UserAssigned KeySource : KeyVaultProperty : Location : North Europe -MetricId : {subscriptionId}:myNamespace +MetricId : 000000000000:myNamespace MinimumTlsVersion : 1.2 Name : myNamespace PrincipalId : 000000000000000 @@ -186,10 +186,10 @@ TenantId : 0000000000000000 Type : Microsoft.ServiceBus/Namespaces UpdatedAt : 11/21/2022 9:15:53 AM UserAssignedIdentity : { - "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/ + "/subscriptions/000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/ userAssignedIdentities/mySecondIdentity": { }, - "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/ + "/subscriptions/000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/ userAssignedIdentities/myFirstIdentity": { } } @@ -201,8 +201,8 @@ Added UserAssigned Identity to Namespace with IdentityType SystemAssigned to tes ### Example 4: # Create a namespace with UserAssignedIdentity and use Set-Az cmdlet to set IdentityType to None. ```powershell -$id1 = "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" -$id2 = "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity" +$id1 = "/subscriptions/000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity" +$id2 = "/subscriptions/000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity" $serviceBusNamespace = New-AzServiceBusNamespaceV2 -ResourceGroupName myResourceGroup -Name myNamespace -SkuName Premium -Location northeurope -IdentityType UserAssigned -UserAssignedIdentityId $id1,$id2 $serviceBusNamespace = Set-AzServiceBusNamespaceV2 -ResourceGroupName myResourceGroup -Name myNamespace -IdentityType None -UserAssignedIdentityId:$null ``` @@ -211,13 +211,13 @@ $serviceBusNamespace = Set-AzServiceBusNamespaceV2 -ResourceGroupName myResource AlternateName : CreatedAt : 11/17/2022 3:54:50 AM DisableLocalAuth : False -Id : /subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/M +Id : /subscriptions/000000000000/resourceGroups/myResourceGroup/providers/M icrosoft.ServiceBus/namespaces/myNamespace IdentityType : KeySource : KeyVaultProperty : Location : North Europe -MetricId : {subscriptionId}:myNamespace +MetricId : 000000000000:myNamespace MinimumTlsVersion : 1.2 Name : myNamespace PrincipalId : diff --git a/src/ServiceBus/ServiceBus.Autorest/how-to.md b/src/ServiceBus/ServiceBus.Autorest/how-to.md index a926aaf7047b..6cb0e1edfd31 100644 --- a/src/ServiceBus/ServiceBus.Autorest/how-to.md +++ b/src/ServiceBus/ServiceBus.Autorest/how-to.md @@ -14,7 +14,7 @@ To generate documentation, the process is now integrated into the `build-module. To test the cmdlets, we use [Pester](https://github.com/pester/Pester). Tests scripts (`.ps1`) should be added to the `test` folder. To execute the Pester tests, run the `test-module.ps1` script. This will run all tests in `playback` mode within the `test` folder. To read more about testing cmdlets, look at the [README.md](examples/README.md) in the `examples` folder. ## Packing `Az.ServiceBus` -To pack `Az.ServiceBus` for distribution, run the `pack-module.ps1` script. This will take the contents of multiple directories and certain root-folder files to create a `.nupkg`. The structure of the `.nupkg` is created so it can be loaded part of a [PSRepository](https://learn.microsoft.com/powershell/module/powershellget/register-psrepository). Additionally, this package is in a format for distribution to the [PSGallery](https://www.powershellgallery.com/). For signing an Azure module, please contact the [Azure PowerShell](https://github.com/Azure/azure-powershell) team. +To pack `Az.ServiceBus` for distribution, run the `pack-module.ps1` script. This will take the contents of multiple directories and certain root-folder files to create a `.nupkg`. The structure of the `.nupkg` is created so it can be loaded part of a [PSRepository](https://docs.microsoft.com/powershell/module/powershellget/register-psrepository). Additionally, this package is in a format for distribution to the [PSGallery](https://www.powershellgallery.com/). For signing an Azure module, please contact the [Azure PowerShell](https://github.com/Azure/azure-powershell) team. ## Module Script Details There are multiple scripts created for performing different actions for developing `Az.ServiceBus`.