Set-AzEventHubNamespace
Met à jour un espace de noms EventHub
Syntaxe
SetExpanded (Par défaut)
Set-AzEventHubNamespace
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[-AlternateName <String>]
[-DisableLocalAuth]
[-KeyVaultProperty <IKeyVaultProperties[]>]
[-RequireInfrastructureEncryption]
[-IdentityType <String>]
[-UserAssignedIdentityId <String[]>]
[-EnableAutoInflate]
[-MaximumThroughputUnit <Int32>]
[-MinimumTlsVersion <String>]
[-PublicNetworkAccess <String>]
[-SkuCapacity <Int32>]
[-Tag <Hashtable>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SetViaIdentityExpanded
Set-AzEventHubNamespace
-InputObject <IEventHubIdentity>
[-AlternateName <String>]
[-DisableLocalAuth]
[-KeyVaultProperty <IKeyVaultProperties[]>]
[-RequireInfrastructureEncryption]
[-IdentityType <String>]
[-UserAssignedIdentityId <String[]>]
[-EnableAutoInflate]
[-MaximumThroughputUnit <Int32>]
[-MinimumTlsVersion <String>]
[-PublicNetworkAccess <String>]
[-SkuCapacity <Int32>]
[-Tag <Hashtable>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Met à jour un espace de noms EventHub
Exemples
Exemple 1 : Ajouter un ManagedIdentity à un espace de noms EventHub
$eventHubNamespace = Get-AzEventHubNamespace -ResourceGroupName myResourceGroup -Name myNamespace
$identityId = $eventHubNamespace.UserAssignedIdentity.Keys
$identityId += "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity"
Set-AzEventHubNamespace -InputObject $eventHubNamespace -UserAssignedIdentityId $identityId
AlternateName :
ClusterArmId :
CreatedAt : 11/17/2022 2:56:32 PM
DisableLocalAuth : False
EnableAutoInflate : False
Id : /subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace
IdentityType : UserAssigned
KafkaEnabled : True
KeySource : Microsoft.KeyVault
KeyVaultProperty : {{
"identity": {
"userAssignedIdentity": "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity"
},
"keyName": "key1",
"keyVaultUri": "https://testkeyvault.vault.azure.net/",
"keyVersion": ""
}, {
"identity": {
"userAssignedIdentity": "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity"
},
"keyName": "key2",
"keyVaultUri": "https://testkeyvault.vault.azure.net/",
"keyVersion": ""
}, {
"identity": {
"userAssignedIdentity": "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity"
},
"keyName": "key3",
"keyVaultUri": "https://testkeyvault.vault.azure.net/",
"keyVersion": ""
}}
Location : North Europe
MaximumThroughputUnit : 0
MetricId : 000000000000000:myNamespace
MinimumTlsVersion : 1.2
Name : myNamespace
PrincipalId :
PrivateEndpointConnection :
ProvisioningState : Succeeded
PublicNetworkAccess : Enabled
RequireInfrastructureEncryption : False
ResourceGroupName : myResourceGroup
ServiceBusEndpoint : https://myNamespace.servicebus.windows.net:443/
SkuCapacity : 1
SkuName : Premium
SkuTier : Premium
Status : Active
Tag : {
}
TenantId :
Type : Microsoft.EventHub/Namespaces
UpdatedAt : 11/17/2022 3:03:50 PM
UserAssignedIdentity : {
"/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity": {
},
"/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity": {
}
}
ZoneRedundant : True
Le type de sortie des applets de commande New and Set a une propriété nommée qui est une table de hachage.
Les clés de cette table de hachage sont les ID de ressource des identités managées dont l’espace de noms fait partie.
Pour ajouter ou supprimer un IdentityId, extrayez les clés de la table de hachage, ce qui entraînerait un tableau de chaînes qui peuvent ensuite être interrogées et alimentées en tant qu’entrée pour définir l’applet de commande comme indiqué ci-dessus.
Exemple 2 : Ajouter un KeyVaultProperty à un espace de noms EventHub existant
$eventHubNamespace = Get-AzEventHubNamespace -ResourceGroupName myResourceGroup -Name myNamespace
$newKeyVaultProperty = New-AzEventHubKeyVaultPropertiesObject -KeyName key3 -KeyVaultUri https://testkeyvault.vault.azure.net -UserAssignedIdentity "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity"
$eventHubNamespace.KeyVaultProperty += $newKeyVaultProperty
Set-AzEventHubNamespace -InputObject $eventHubNamespace -KeyVaultProperty $eventHubNamespace.KeyVaultProperty
AlternateName :
ClusterArmId :
CreatedAt : 11/17/2022 2:56:32 PM
DisableLocalAuth : False
EnableAutoInflate : False
Id : /subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace
IdentityType : UserAssigned
KafkaEnabled : True
KeySource : Microsoft.KeyVault
KeyVaultProperty : {{
"identity": {
"userAssignedIdentity": "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity"
},
"keyName": "key1",
"keyVaultUri": "https://testkeyvault.vault.azure.net",
"keyVersion": ""
}, {
"identity": {
"userAssignedIdentity": "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity"
},
"keyName": "key2",
"keyVaultUri": "https://testkeyvault.vault.azure.net",
"keyVersion": ""
}, {
"identity": {
"userAssignedIdentity": "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity"
},
"keyName": "key3",
"keyVaultUri": "https://testkeyvault.vault.azure.net",
"keyVersion": ""
}}
Location : North Europe
MaximumThroughputUnit : 0
MetricId : 000000000000000:myNamespace
MinimumTlsVersion : 1.2
Name : myNamespace
PrincipalId :
PrivateEndpointConnection :
ProvisioningState : Succeeded
PublicNetworkAccess : Enabled
RequireInfrastructureEncryption : False
ResourceGroupName : myResourceGroup
ServiceBusEndpoint : https://myNamespace.servicebus.windows.net:443/
SkuCapacity : 1
SkuName : Premium
SkuTier : Premium
Status : Active
Tag : {
}
TenantId :
Type : Microsoft.EventHub/Namespaces
UpdatedAt : 11/17/2022 3:03:50 PM
UserAssignedIdentity : {
"/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity": {
},
"/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity": {
}
}
ZoneRedundant : True
Ajoute un nouveau KeyVaultProperty à l’espace de noms EventHub.
Exemple 3 : Supprimer un KeyVaultProperty d’un espace de noms EventHub existant
$eventHubNamespace = Get-AzEventHubNamespace -ResourceGroupName myResourceGroup -Name myNamespace
# Remove the last KeyVaultProperty from the list of KeyVaultProperties
$eventHubNamespace.KeyVaultProperty = $eventHubNamespace.KeyVaultProperty | Where-Object { $_ -ne $eventHubNamespace.KeyVaultProperty[2] }
Set-AzEventHubNamespace -InputObject $eventHubNamespace -KeyVaultProperty $eventHubNamespace.KeyVaultProperty
AlternateName :
ClusterArmId :
CreatedAt : 11/17/2022 2:56:32 PM
DisableLocalAuth : False
EnableAutoInflate : False
Id : /subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace
IdentityType : UserAssigned
KafkaEnabled : True
KeySource : Microsoft.KeyVault
KeyVaultProperty : {{
"identity": {
"userAssignedIdentity": "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity"
},
"keyName": "key1",
"keyVaultUri": "https://testkeyvault.vault.azure.net",
"keyVersion": ""
}, {
"identity": {
"userAssignedIdentity": "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity"
},
"keyName": "key2",
"keyVaultUri": "https://testkeyvault.vault.azure.net",
"keyVersion": ""
}}
Location : North Europe
MaximumThroughputUnit : 0
MetricId : 000000000000000:myNamespace
MinimumTlsVersion : 1.2
Name : myNamespace
PrincipalId :
PrivateEndpointConnection :
ProvisioningState : Succeeded
PublicNetworkAccess : Enabled
RequireInfrastructureEncryption : False
ResourceGroupName : myResourceGroup
ServiceBusEndpoint : https://myNamespace.servicebus.windows.net:443/
SkuCapacity : 1
SkuName : Premium
SkuTier : Premium
Status : Active
Tag : {
}
TenantId :
Type : Microsoft.EventHub/Namespaces
UpdatedAt : 11/17/2022 3:03:50 PM
UserAssignedIdentity : {
"/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity": {
},
"/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity": {
}
}
ZoneRedundant : True
Supprime un nouvel espace de noms KeyVaultProperty dans EventHub.
Exemple 4 : Définir DisableLocalAuth sur true sur un espace de noms EventHub existant
Set-AzEventHubNamespace -ResourceGroupName myResourceGroup -Name myNamespace -DisableLocalAuth
AlternateName :
ClusterArmId :
CreatedAt : 11/17/2022 2:56:32 PM
DisableLocalAuth : False
EnableAutoInflate : False
Id : /subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace
IdentityType : UserAssigned
KafkaEnabled : True
KeySource : Microsoft.KeyVault
KeyVaultProperty : {{
"identity": {
"userAssignedIdentity": "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity"
},
"keyName": "key1",
"keyVaultUri": "https://testkeyvault.vault.azure.net",
"keyVersion": ""
}, {
"identity": {
"userAssignedIdentity": "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity"
},
"keyName": "key2",
"keyVaultUri": "https://testkeyvault.vault.azure.net",
"keyVersion": ""
}}
Location : North Europe
MaximumThroughputUnit : 0
MetricId : 000000000000000:myNamespace
MinimumTlsVersion : 1.2
Name : myNamespace
PrincipalId :
PrivateEndpointConnection :
ProvisioningState : Succeeded
PublicNetworkAccess : Enabled
RequireInfrastructureEncryption : False
ResourceGroupName : myResourceGroup
ServiceBusEndpoint : https://myNamespace.servicebus.windows.net:443/
SkuCapacity : 1
SkuName : Premium
SkuTier : Premium
Status : Active
Tag : {
}
TenantId :
Type : Microsoft.EventHub/Namespaces
UpdatedAt : 11/17/2022 3:03:50 PM
UserAssignedIdentity : {
"/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity": {
},
"/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/mySecondIdentity": {
}
}
ZoneRedundant : True
Définit la valeur true sur un espace de noms EventHub .
Exemple 5 : # Créer un espace de noms avec UserAssignedIdentity et utiliser Set-Az applet de commande pour définir IdentityType sur None.
$eventHubNamespace = New-AzEventHubNamespace -ResourceGroupName myResourceGroup -Name myNamespace -SkuName Premium -Location northeurope -IdentityType UserAssigned -UserAssignedIdentityId "/subscriptions/000000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myFirstIdentity"
$eventHubNamespace = Set-AzEventHubNamespace -ResourceGroupName myResourceGroup -Name myNamespace -IdentityType None -UserAssignedIdentityId @()
AlternateName :
ClusterArmId :
CreatedAt : 11/21/2022 3:21:29 PM
DisableLocalAuth : False
EnableAutoInflate : False
Id : /subscriptions/000000000000000/resourceGroups/myResourceGroup/provide
rs/Microsoft.EventHub/namespaces/myNamespace
IdentityType :
KafkaEnabled : True
KeySource :
KeyVaultProperty :
Location : North Europe
MaximumThroughputUnit : 0
MetricId : 000000000000000:myNamespace
MinimumTlsVersion : 1.2
Name : myNamespace
PrincipalId :
PrivateEndpointConnection :
ProvisioningState : Succeeded
PublicNetworkAccess : Enabled
RequireInfrastructureEncryption :
ResourceGroupName : myResourceGroup
ServiceBusEndpoint : https://myNamespace.servicebus.windows.net:443/
SkuCapacity : 1
SkuName : Premium
SkuTier : Premium
Status : Active
SystemDataCreatedAt :
SystemDataCreatedBy :
SystemDataCreatedByType :
SystemDataLastModifiedAt :
SystemDataLastModifiedBy :
SystemDataLastModifiedByType :
Tag : {
}
TenantId :
Type : Microsoft.EventHub/Namespaces
UpdatedAt : 11/21/2022 3:31:03 PM
UserAssignedIdentity : {
}
ZoneRedundant : True
Crée un espace de noms avec UserAssignedIdentity et utilise Set-Az applet de commande pour définir IdentityType sur None.
Paramètres
-AlternateName
Autre nom spécifié lorsque les noms d’alias et d’espace de noms sont identiques
Propriétés du paramètre
Type: String
Valeur par défaut: None
Prend en charge les caractères génériques: False
DontShow: False
Jeux de paramètres
(All)
Position: Named
Obligatoire: False
Valeur du pipeline: False
Valeur du pipeline par nom de propriété: False
Valeur des arguments restants: False
-AsJob
Exécuter la commande en tant que travail
Propriétés du paramètre
Type: SwitchParameter
Valeur par défaut: None
Prend en charge les caractères génériques: False
DontShow: False
Jeux de paramètres
(All)
Position: Named
Obligatoire: False
Valeur du pipeline: False
Valeur du pipeline par nom de propriété: False
Valeur des arguments restants: False
-Confirm
Vous invite à confirmer avant d’exécuter l’applet de commande.
Propriétés du paramètre
Type: SwitchParameter
Valeur par défaut: None
Prend en charge les caractères génériques: False
DontShow: False
Alias: Cf
Jeux de paramètres
(All)
Position: Named
Obligatoire: False
Valeur du pipeline: False
Valeur du pipeline par nom de propriété: False
Valeur des arguments restants: False
-DefaultProfile
Informations d’identification, compte, locataire et abonnement utilisés pour la communication avec Azure.
Propriétés du paramètre
Type: PSObject
Valeur par défaut: None
Prend en charge les caractères génériques: False
DontShow: False
Alias: AzureRMContext, AzureCredential
Jeux de paramètres
(All)
Position: Named
Obligatoire: False
Valeur du pipeline: False
Valeur du pipeline par nom de propriété: False
Valeur des arguments restants: False
-DisableLocalAuth
Cette propriété désactive l’authentification SAP pour l’espace de noms Event Hubs.
Propriétés du paramètre
Type: SwitchParameter
Valeur par défaut: None
Prend en charge les caractères génériques: False
DontShow: False
Jeux de paramètres
(All)
Position: Named
Obligatoire: False
Valeur du pipeline: False
Valeur du pipeline par nom de propriété: False
Valeur des arguments restants: False
-EnableAutoInflate
Valeur qui indique si AutoInflate est activé pour l’espace de noms eventhub.
Propriétés du paramètre
Type: SwitchParameter
Valeur par défaut: None
Prend en charge les caractères génériques: False
DontShow: False
Jeux de paramètres
(All)
Position: Named
Obligatoire: False
Valeur du pipeline: False
Valeur du pipeline par nom de propriété: False
Valeur des arguments restants: False
-IdentityType
Type d’identité de service managé.
Propriétés du paramètre
Type: String
Valeur par défaut: None
Prend en charge les caractères génériques: False
DontShow: False
Jeux de paramètres
(All)
Position: Named
Obligatoire: False
Valeur du pipeline: False
Valeur du pipeline par nom de propriété: False
Valeur des arguments restants: False
Paramètre d’identité.
Pour construire, consultez la section NOTES pour les propriétés INPUTOBJECT et créez une table de hachage.
Type: IEventHubIdentity
Valeur par défaut: None
Prend en charge les caractères génériques: False
DontShow: False
SetViaIdentityExpanded
Position: Named
Obligatoire: True
Valeur du pipeline: True
Valeur du pipeline par nom de propriété: False
Valeur des arguments restants: False
-KeyVaultProperty
Propriétés pour configurer le chiffrement
Propriétés du paramètre
Type: IKeyVaultProperties [ ]
Valeur par défaut: None
Prend en charge les caractères génériques: False
DontShow: False
Jeux de paramètres
(All)
Position: Named
Obligatoire: False
Valeur du pipeline: False
Valeur du pipeline par nom de propriété: False
Valeur des arguments restants: False
-MaximumThroughputUnit
Limite supérieure des unités de débit lorsque AutoInflate est activé, la valeur doit être comprise entre 0 et 20 unités de débit.
( '0' si AutoInflateEnabled = true)
Propriétés du paramètre
Type: Int32
Valeur par défaut: None
Prend en charge les caractères génériques: False
DontShow: False
Jeux de paramètres
(All)
Position: Named
Obligatoire: False
Valeur du pipeline: False
Valeur du pipeline par nom de propriété: False
Valeur des arguments restants: False
-MinimumTlsVersion
Version TLS minimale pour le cluster à prendre en charge, par exemple « 1.2 ».
Propriétés du paramètre
Type: String
Valeur par défaut: None
Prend en charge les caractères génériques: False
DontShow: False
Jeux de paramètres
(All)
Position: Named
Obligatoire: False
Valeur du pipeline: False
Valeur du pipeline par nom de propriété: False
Valeur des arguments restants: False
-Name
Nom de l’espace de noms EventHub.
Propriétés du paramètre
Type: String
Valeur par défaut: None
Prend en charge les caractères génériques: False
DontShow: False
Jeux de paramètres
SetExpanded
Position: Named
Obligatoire: True
Valeur du pipeline: False
Valeur du pipeline par nom de propriété: False
Valeur des arguments restants: False
-PublicNetworkAccess
Cela détermine si le trafic est autorisé sur le réseau public.
Par défaut, elle est activée.
Propriétés du paramètre
Type: String
Valeur par défaut: None
Prend en charge les caractères génériques: False
DontShow: False
Jeux de paramètres
(All)
Position: Named
Obligatoire: False
Valeur du pipeline: False
Valeur du pipeline par nom de propriété: False
Valeur des arguments restants: False
-RequireInfrastructureEncryption
Activer le chiffrement d’infrastructure (double chiffrement)
Propriétés du paramètre
Type: SwitchParameter
Valeur par défaut: None
Prend en charge les caractères génériques: False
DontShow: False
Jeux de paramètres
(All)
Position: Named
Obligatoire: False
Valeur du pipeline: False
Valeur du pipeline par nom de propriété: False
Valeur des arguments restants: False
-ResourceGroupName
Nom du groupe de ressources.
Le nom ne respecte pas la casse.
Propriétés du paramètre
Type: String
Valeur par défaut: None
Prend en charge les caractères génériques: False
DontShow: False
Jeux de paramètres
SetExpanded
Position: Named
Obligatoire: True
Valeur du pipeline: False
Valeur du pipeline par nom de propriété: False
Valeur des arguments restants: False
-SkuCapacity
Unités de débit Event Hubs pour les niveaux De base ou Standard, où la valeur doit être de 0 à 20 unités de débit.
Unités Premium Event Hubs pour le niveau Premium, où la valeur doit être comprise entre 0 et 10 unités Premium.
Propriétés du paramètre
Type: Int32
Valeur par défaut: None
Prend en charge les caractères génériques: False
DontShow: False
Jeux de paramètres
(All)
Position: Named
Obligatoire: False
Valeur du pipeline: False
Valeur du pipeline par nom de propriété: False
Valeur des arguments restants: False
-SubscriptionId
ID de l’abonnement cible.
Propriétés du paramètre
Type: String
Valeur par défaut: (Get-AzContext).Subscription.Id
Prend en charge les caractères génériques: False
DontShow: False
Jeux de paramètres
SetExpanded
Position: Named
Obligatoire: False
Valeur du pipeline: False
Valeur du pipeline par nom de propriété: False
Valeur des arguments restants: False
-Tag
Balise de l’espace de noms EventHub.
Propriétés du paramètre
Type: Hashtable
Valeur par défaut: None
Prend en charge les caractères génériques: False
DontShow: False
Jeux de paramètres
(All)
Position: Named
Obligatoire: False
Valeur du pipeline: False
Valeur du pipeline par nom de propriété: False
Valeur des arguments restants: False
-UserAssignedIdentityId
Propriétés des identités affectées par l’utilisateur
Propriétés du paramètre
Type: String [ ]
Valeur par défaut: None
Prend en charge les caractères génériques: False
DontShow: False
Jeux de paramètres
(All)
Position: Named
Obligatoire: False
Valeur du pipeline: False
Valeur du pipeline par nom de propriété: False
Valeur des arguments restants: False
-WhatIf
Affiche ce qui se passerait si l’applet de commande s’exécute.
L’applet de commande ne s’exécute pas.
Propriétés du paramètre
Type: SwitchParameter
Valeur par défaut: None
Prend en charge les caractères génériques: False
DontShow: False
Alias: Wi
Jeux de paramètres
(All)
Position: Named
Obligatoire: False
Valeur du pipeline: False
Valeur du pipeline par nom de propriété: False
Valeur des arguments restants: False
CommonParameters
Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.
Sorties
Notes
ALIAS
Set-AzEventHubNamespaceV2