Set-AzIoTDeviceProvisioningServiceEnrollment
Cette applet de commande fait partie d’un module en préversion . Les versions en préversion ne sont pas recommandées pour une utilisation dans les environnements de production. Pour plus d’informations, consultez .
Mettez à jour un enregistrement d’inscription d’appareil.
Syntaxe
ResourceSet (Par défaut)
Set-AzIoTDeviceProvisioningServiceEnrollment
[-ResourceGroupName] <String>
[-DpsName] <String>
-RegistrationId <String>
[-DeviceId <String>]
[-ReprovisionPolicy <PSReprovisionType>]
[-EdgeEnabled <Boolean>]
[-Tag <Hashtable>]
[-Desired <Hashtable>]
[-AllocationPolicy <PSAllocationPolicy>]
[-ProvisioningStatus <PSProvisioningStatus>]
[-IotHubHostName <String>]
[-IotHub <String[]>]
[-WebhookUrl <String>]
[-ApiVersion <String>]
[-EndorsementKey <String>]
[-StorageRootKey <String>]
[-PrimaryKey <String>]
[-SecondaryKey <String>]
[-PrimaryCertificate <String>]
[-SecondaryCertificate <String>]
[-RootCertificate]
[-PrimaryCAName <String>]
[-SecondaryCAName <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzIoTDeviceProvisioningServiceEnrollment
[-DpsObject] <PSProvisioningServiceDescription>
-RegistrationId <String>
[-DeviceId <String>]
[-ReprovisionPolicy <PSReprovisionType>]
[-EdgeEnabled <Boolean>]
[-Tag <Hashtable>]
[-Desired <Hashtable>]
[-AllocationPolicy <PSAllocationPolicy>]
[-ProvisioningStatus <PSProvisioningStatus>]
[-IotHubHostName <String>]
[-IotHub <String[]>]
[-WebhookUrl <String>]
[-ApiVersion <String>]
[-EndorsementKey <String>]
[-StorageRootKey <String>]
[-PrimaryKey <String>]
[-SecondaryKey <String>]
[-PrimaryCertificate <String>]
[-SecondaryCertificate <String>]
[-RootCertificate]
[-PrimaryCAName <String>]
[-SecondaryCAName <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ResourceIdSet
Set-AzIoTDeviceProvisioningServiceEnrollment
[-ResourceId] <String>
-RegistrationId <String>
[-DeviceId <String>]
[-ReprovisionPolicy <PSReprovisionType>]
[-EdgeEnabled <Boolean>]
[-Tag <Hashtable>]
[-Desired <Hashtable>]
[-AllocationPolicy <PSAllocationPolicy>]
[-ProvisioningStatus <PSProvisioningStatus>]
[-IotHubHostName <String>]
[-IotHub <String[]>]
[-WebhookUrl <String>]
[-ApiVersion <String>]
[-EndorsementKey <String>]
[-StorageRootKey <String>]
[-PrimaryKey <String>]
[-SecondaryKey <String>]
[-PrimaryCertificate <String>]
[-SecondaryCertificate <String>]
[-RootCertificate]
[-PrimaryCAName <String>]
[-SecondaryCAName <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Mettez à jour une inscription d’appareil dans un service d’approvisionnement d’appareils Azure IoT Hub.
Exemples
Exemple 1
Set-AzIoTDeviceProvisioningServiceEnrollment -ResourceGroupName "myresourcegroup" -DpsName "mydps" -RegistrationId "enroll1" -AllocationPolicy Hashed -IotHub "hub1","hub2"
Mettez à jour la stratégie d’allocation et les hubs pour un enregistrement d’inscription.
Exemple 2
$tag = @{}
$tag.Add("environment","updatedenv")
$desired = @{}
$desired.add("version_dps", "updateddps")
Set-AzIoTDeviceProvisioningServiceEnrollment -ResourceGroupName "myresourcegroup" -DpsName "mydps" -RegistrationId "enroll1" -tag $tag -Desired $desired
Mettez à jour l’état initial du jumeau d’une inscription.
Exemple 3
Set-AzIoTDeviceProvisioningServiceEnrollment -ResourceGroupName "myresourcegroup" -DpsName "mydps" -RegistrationId "enroll1" -PrimaryCertificate ".\primaryCertificate.cer" -SecondaryCertificate ".\secondaryCertificate.cer"
Mettre à jour les certificats principaux et secondaires d’une inscription à clé symétrique
Paramètres
-AllocationPolicy
Type d’allocation pour l’appareil affecté au hub.
Propriétés du paramètre
Type: PSAllocationPolicy
Valeur par défaut: None Valeurs acceptées: Hashed, GeoLatency, Static, Custom 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
-ApiVersion
Version de l’API du service d’approvisionnement dans la demande d’allocation personnalisé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
-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: IAzureContextContainer
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False Alias: AzContext, 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
-Desired
Propriétés souhaitées du jumeau initial.
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
-DeviceId
IoT Hub ID d’appareil.
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
-DpsName
Nom du service IoT Device Provisioning
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
ResourceSet
Position: 1 Obligatoire: True Valeur du pipeline: False Valeur du pipeline par nom de propriété: False Valeur des arguments restants: False
-DpsObject
Objet de service IoT Device Provisioning
Propriétés du paramètre
Jeux de paramètres
InputObjectSet
Position: 0 Obligatoire: True Valeur du pipeline: True Valeur du pipeline par nom de propriété: False Valeur des arguments restants: False
-EdgeEnabled
Indicateur indiquant l’activation de périphérie.
Propriétés du paramètre
Type: Boolean
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
-EndorsementKey
Clé d’approbation TPM pour un appareil TPM.
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
-IotHub
Nom d’hôte du IoT Hub cible.
Utilisez la liste séparée par l’espace pour plusieurs Hubs IoT.
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
-IotHubHostName
Nom d’hôte du IoT Hub cible.
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
-PrimaryCAName
Nom du certificat d’autorité de certification racine primaire.
Si l’attestation avec un certificat d’autorité de certification racine est souhaitée, un nom d’autorité de certification racine doit être fourni.
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
-PrimaryCertificate
Chemin d’accès au fichier contenant le certificat principal.
Représentation en base 64 du certificat X509 .cer fichier ou chemin d’accès au fichier .pem.
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
-PrimaryKey
Clé d’accès partagé symétrique primaire stockée au format base64.
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
-ProvisioningStatus
Activez ou désactivez l’entrée d’inscription.
Propriétés du paramètre
Type: PSProvisioningStatus
Valeur par défaut: None Valeurs acceptées: Enabled, Disabled 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
-RegistrationId
ID d’inscription d’inscription individuelle.
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: True Valeur du pipeline: False Valeur du pipeline par nom de propriété: False Valeur des arguments restants: False
-ReprovisionPolicy
Données d’appareil à gérer lors de la réapprovisionnement sur différents Iot Hub.
Propriétés du paramètre
Type: PSReprovisionType
Valeur par défaut: None Valeurs acceptées: reprovisionandmigratedata, reprovisionandresetdata, never 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
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
ResourceSet
Position: 0 Obligatoire: True Valeur du pipeline: False Valeur du pipeline par nom de propriété: False Valeur des arguments restants: False
-ResourceId
ID de ressource du service IoT Device Provisioning
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
ResourceIdSet
Position: 0 Obligatoire: True Valeur du pipeline: False Valeur du pipeline par nom de propriété: True Valeur des arguments restants: False
-RootCertificate
Basculez pour mettre à jour X509attestation à l’aide de certificats racines.
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
-SecondaryCAName
Nom du certificat d’autorité de certification racine secondaire.
Si l’attestation avec un certificat d’autorité de certification racine est souhaitée, un nom d’autorité de certification racine doit être fourni.
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
-SecondaryCertificate
Chemin d’accès au fichier contenant le certificat secondaire.
Représentation en base 64 du certificat X509 .cer fichier ou chemin d’accès au fichier .pem.
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
-SecondaryKey
Clé d’accès partagé symétrique secondaire stockée au format base64.
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
-StorageRootKey
Clé racine de stockage TPM pour un appareil TPM.
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
-Tag
Balises de jumeau initiales.
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
-WebhookUrl
URL du webhook utilisée pour les demandes d’allocation personnalisées.
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