Partager via


Set-AzIoTDeviceProvisioningServiceEnrollment

Mettez à jour un enregistrement d’inscription d’appareil.

Syntaxe

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>]
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 Azure IoT Hub Device Provisioning.

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.

Type:PSAllocationPolicy
Valeurs acceptées:Hashed, GeoLatency, Static, Custom
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ApiVersion

Version de l’API du service d’approvisionnement dans la demande d’allocation personnalisée.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Confirm

Vous invite à confirmer avant d’exécuter l’applet de commande.

Type:SwitchParameter
Alias:cf
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-DefaultProfile

Informations d’identification, compte, locataire et abonnement utilisés pour la communication avec Azure.

Type:IAzureContextContainer
Alias:AzContext, AzureRmContext, AzureCredential
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Desired

Propriétés souhaitées du jumeau initial.

Type:Hashtable
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-DeviceId

ID d’appareil IoT Hub.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-DpsName

Nom du service IoT Device Provisioning

Type:String
Position:1
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-DpsObject

Objet de service IoT Device Provisioning

Type:PSProvisioningServiceDescription
Position:0
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-EdgeEnabled

Indicateur indiquant l’activation de périphérie.

Type:Boolean
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-EndorsementKey

Clé d’approbation TPM pour un appareil TPM.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-IotHub

Nom d’hôte de l’IoT Hub cible. Utilisez la liste séparée par l’espace pour plusieurs Hubs IoT.

Type:String[]
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-IotHubHostName

Nom d’hôte du hub IoT cible.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques: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.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques: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.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-PrimaryKey

Clé d’accès partagé symétrique primaire stockée au format base64.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ProvisioningStatus

Activez ou désactivez l’entrée d’inscription.

Type:PSProvisioningStatus
Valeurs acceptées:Enabled, Disabled
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-RegistrationId

ID d’inscription d’inscription individuelle.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ReprovisionPolicy

Données d’appareil à gérer lors de la réapprovisionnement sur différents Iot Hub.

Type:PSReprovisionType
Valeurs acceptées:reprovisionandmigratedata, reprovisionandresetdata, never
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ResourceGroupName

Nom du groupe de ressources

Type:String
Position:0
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ResourceId

ID de ressource du service IoT Device Provisioning

Type:String
Position:0
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-RootCertificate

Basculez pour mettre à jour X509attestation à l’aide de certificats racines.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques: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.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques: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.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-SecondaryKey

Clé d’accès partagé symétrique secondaire stockée au format base64.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-StorageRootKey

Clé racine de stockage TPM pour un appareil TPM.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Tag

Balises de jumeau initiales.

Type:Hashtable
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-WebhookUrl

URL du webhook utilisée pour les demandes d’allocation personnalisées.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-WhatIf

Affiche ce qui se passerait si l’applet de commande s’exécute. L’applet de commande n’est pas exécutée.

Type:SwitchParameter
Alias:wi
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

Entrées

PSProvisioningServiceDescription

String

Sorties

PSIndividualEnrollment