Delen via


az iot dps enrollment-group

Note

Deze verwijzing maakt deel uit van de Azure-iot-extensie voor de Azure CLI (versie 2.67.0 of hoger). De extensie installeert automatisch de eerste keer dat u een az iot dps enrollment-group opdracht uitvoert. Meer informatie over uitbreidingen.

Inschrijvingsgroepen beheren in een Azure IoT Hub Device Provisioning Service.

Opdracht

Name Description Type Status
az iot dps enrollment-group compute-device-key

Genereer een AFGELEIDE SAS-sleutel voor een inschrijvingsgroep in een Azure IoT Hub Device Provisioning Service.

Extension GA
az iot dps enrollment-group create

Maak een inschrijvingsgroep in een Azure IoT Hub Device Provisioning Service.

Extension GA
az iot dps enrollment-group delete

Een inschrijvingsgroep verwijderen in een Azure IoT Hub Device Provisioning Service.

Extension GA
az iot dps enrollment-group list

Registratiegroepen weergeven in een Azure IoT Hub Device Provisioning Service.

Extension GA
az iot dps enrollment-group registration

Apparaatregistraties aan de servicezijde beheren voor een inschrijvingsgroep in een Azure IoT Hub Device Provisioning Service.

Extension GA
az iot dps enrollment-group registration delete

Verwijder een apparaatregistratie voor een inschrijvingsgroep in een Azure IoT Hub Device Provisioning Service.

Extension GA
az iot dps enrollment-group registration list

Apparaatregistraties weergeven voor een inschrijvingsgroep in een Azure IoT Hub Device Provisioning Service.

Extension GA
az iot dps enrollment-group registration show

Haal een apparaatregistratie op voor een inschrijvingsgroep in een Azure IoT Hub Device Provisioning Service.

Extension GA
az iot dps enrollment-group show

Haal de details van een inschrijvingsgroep op in een Azure IoT Hub Device Provisioning Service.

Extension GA
az iot dps enrollment-group update

Werk een inschrijvingsgroep bij in een Azure IoT Hub Device Provisioning Service.

Extension GA

az iot dps enrollment-group compute-device-key

Genereer een AFGELEIDE SAS-sleutel voor een inschrijvingsgroep in een Azure IoT Hub Device Provisioning Service.

az iot dps enrollment-group compute-device-key --registration-id --rid
                                               [--auth-type {key, login}]
                                               [--dps-name]
                                               [--eid --enrollment-id --gid --group-id]
                                               [--key --symmetric-key]
                                               [--login]
                                               [--resource-group]

Voorbeelden

Bereken de apparaatsleutel met de opgegeven symmetrische sleutel.

az iot dps enrollment-group compute-device-key --key {enrollement_group_symmetric_key} --registration-id {registration_id}

Bereken de apparaatsleutel met de opgegeven inschrijvingsgroep.

az iot dps enrollment-group compute-device-key -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --registration-id {registration_id}

Vereiste parameters

--registration-id --rid

Id van apparaatregistratie.

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--auth-type

Hiermee wordt aangegeven of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. Als het verificatietype aanmelding is en de hostnaam van de resource wordt opgegeven, wordt het opzoeken van resources overgeslagen, tenzij dat nodig is. U kunt de standaardinstelling configureren met behulp van az configure --defaults iotdps-data-auth-type={auth-type-value}.

Eigenschap Waarde
Parametergroep: Access Control Arguments
Default value: key
Geaccepteerde waarden: key, login
--dps-name -n

De naam of hostnaam van de Azure IoT Hub Device Provisioning Service. Vereist als --login niet is opgegeven.

Eigenschap Waarde
Parametergroep: Device Provisioning Service Identifier Arguments
--eid --enrollment-id --gid --group-id

Id van inschrijvingsgroep.

--key --symmetric-key

De symmetrische gedeelde toegangssleutel voor de inschrijvingsgroep. Hiermee wordt het Device Provisioning Service-register omzeild en wordt het SAS-token rechtstreeks gegenereerd vanaf de opgegeven symmetrische sleutel zonder verdere validatie. Alle andere opdrachtparameters naast registratie-id worden genegeerd.

--login -l

Deze opdracht ondersteunt een entiteitsverbindingsreeks met rechten om actie uit te voeren. Gebruik dit om sessieaanmelding te voorkomen via 'az login'. Als zowel een entiteitsverbindingsreeks als de naam worden opgegeven, heeft de verbindingsreeks prioriteit. Vereist als --dps-name niet is opgegeven.

Eigenschap Waarde
Parametergroep: Device Provisioning Service Identifier Arguments
--resource-group -g

Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap Waarde
Default value: False

az iot dps enrollment-group create

Maak een inschrijvingsgroep in een Azure IoT Hub Device Provisioning Service.

Geef de certificaatindeling op met base64 ASCII-codering en het certificaat moet overeenkomende BEGIN- en END-segmenten hebben, bijvoorbeeld: begin met '-----BEGIN CERTIFICATE-----' en eindig op '-----END CERTIFICATE-----'.

az iot dps enrollment-group create --eid --enrollment-id --gid --group-id
                                   [--allocation-policy --ap {custom, geoLatency, hashed, static}]
                                   [--api-version --av]
                                   [--auth-type {key, login}]
                                   [--ca-name --cn --root-ca-name]
                                   [--certificate-path --cp]
                                   [--cpn --credential-policy-name]
                                   [--dps-name]
                                   [--edge-enabled --ee {false, true}]
                                   [--ih --iot-hubs]
                                   [--initial-twin-properties --props]
                                   [--initial-twin-tags --tags]
                                   [--login]
                                   [--pk --primary-key]
                                   [--provisioning-status --ps {disabled, enabled}]
                                   [--reprovision-policy --rp {never, reprovisionandmigratedata, reprovisionandresetdata}]
                                   [--resource-group]
                                   [--scn --secondary-ca-name --secondary-root-ca-name]
                                   [--scp --secondary-certificate-path]
                                   [--secondary-key --sk]
                                   [--webhook-url --wh]

Voorbeelden

Maak een inschrijvingsgroep {enrollment_id} in de Azure IoT-inrichtingsservice {dps_name} in de resourcegroep {resource_group_name} met behulp van een tussenliggend certificaat als primair certificaat.

az iot dps enrollment-group create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --certificate-path /certificates/Certificate.pem

Maak een inschrijvingsgroep {enrollment_id} in de Azure IoT-inrichtingsservice {dps_name} in de resourcegroep {resource_group_name} met behulp van een CA-certificaat {certificate_name} als secundair certificaat.

az iot dps enrollment-group create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --secondary-ca-name {certificate_name}

Maak een inschrijvingsgroep {enrollment_id} in de Azure IoT-inrichtingsservice 'MyDps' in de resourcegroep {resource_group_name} met de inrichtingsstatus 'ingeschakeld', initiële dubbeleigenschappen {"location":{"region":"US"}} en eerste dubbeltags {"version_dps":"1"} met behulp van een tussenliggend certificaat als primair certificaat.

az iot dps enrollment-group create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --certificate-path /certificates/Certificate.pem --provisioning-status enabled --initial-twin-properties "{'location':{'region':'US'}}" --initial-twin-tags "{'version_dps':'1'}"

Maak een inschrijvingsgroep {enrollment_id} in de Azure IoT-inrichtingsservice {dps_name} in de resourcegroep {resource_group_name} met het attestation-type 'symmetrickey'.

az iot dps enrollment-group create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --primary-key {primary_key} --secondary-key {secondary_key}

Maak een inschrijvingsgroep {enrollment_id} met aangepast toewijzingsbeleid,

az iot dps enrollment-group create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --allocation-policy custom --webhook-url {webhook_url} --api-version {api_version}

Maak een inschrijvingsgroep met een aangepast referentiebeleid voor apparaatregisternaamruimte opgegeven.

az iot dps enrollment-group create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --allocation-policy hashed --credential-policy-name {policy_name}

Vereiste parameters

--eid --enrollment-id --gid --group-id

Id van inschrijvingsgroep.

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--allocation-policy --ap

Type toewijzingsbeleid om te bepalen hoe een apparaat wordt toegewezen aan een IoT Hub. Als dit niet is opgegeven, is het toewijzingsbeleid de standaardinstelling voor het huidige toewijzingsbeleid dat is ingesteld voor het Device Provisioning Service-exemplaar.

Eigenschap Waarde
Parametergroep: Allocation Policy Arguments
Geaccepteerde waarden: custom, geoLatency, hashed, static
--api-version --av

De API-versie van de inrichtingsservicetypen die zijn verzonden in de aangepaste toewijzingsaanvraag. Minimaal ondersteunde versie: 2018-09-01-preview.

Eigenschap Waarde
Parametergroep: Allocation Policy Arguments
--auth-type

Hiermee wordt aangegeven of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. Als het verificatietype aanmelding is en de hostnaam van de resource wordt opgegeven, wordt het opzoeken van resources overgeslagen, tenzij dat nodig is. U kunt de standaardinstelling configureren met behulp van az configure --defaults iotdps-data-auth-type={auth-type-value}.

Eigenschap Waarde
Parametergroep: Access Control Arguments
Default value: key
Geaccepteerde waarden: key, login
--ca-name --cn --root-ca-name

De naam van het primaire basis-CA-certificaat. Als attestation met een basis-CA-certificaat gewenst is, moet er een basis-CA-naam worden opgegeven.

Eigenschap Waarde
Parametergroep: Authentication Arguments
--certificate-path --cp

Het pad naar het bestand met het primaire certificaat. Als attestation met een tussencertificaat gewenst is, moet er een certificaatpad worden opgegeven.

Eigenschap Waarde
Parametergroep: Authentication Arguments
--cpn --credential-policy-name

Naam van adr-naamruimtereferentiebeleid.

Eigenschap Waarde
Parametergroep: ADR Credential Policy Arguments
--dps-name -n

De naam of hostnaam van de Azure IoT Hub Device Provisioning Service. Vereist als --login niet is opgegeven.

Eigenschap Waarde
Parametergroep: Device Provisioning Service Identifier Arguments
--edge-enabled --ee

Vlag die aangeeft dat edge is ingeschakeld.

Eigenschap Waarde
Default value: False
Geaccepteerde waarden: false, true
--ih --iot-hubs

Hostnaam van de doel-IoT Hub die is gekoppeld aan het toewijzingsbeleid. Gebruik een door spaties gescheiden lijst voor meerdere IoT Hubs.

Eigenschap Waarde
Parametergroep: Allocation Policy Arguments
--initial-twin-properties --props

Initiële eigenschappen van apparaatdubbels.

--initial-twin-tags --tags

Eerste tags voor apparaatdubbels.

--login -l

Deze opdracht ondersteunt een entiteitsverbindingsreeks met rechten om actie uit te voeren. Gebruik dit om sessieaanmelding te voorkomen via 'az login'. Als zowel een entiteitsverbindingsreeks als de naam worden opgegeven, heeft de verbindingsreeks prioriteit. Vereist als --dps-name niet is opgegeven.

Eigenschap Waarde
Parametergroep: Device Provisioning Service Identifier Arguments
--pk --primary-key

De primaire symmetrische gedeelde toegangssleutel die is opgeslagen in base64-indeling.

Eigenschap Waarde
Parametergroep: Authentication Arguments
--provisioning-status --ps

Inschrijvingsvermelding in- of uitschakelen.

Eigenschap Waarde
Geaccepteerde waarden: disabled, enabled
--reprovision-policy --rp

Beleid om te bepalen hoe apparaatgegevens moeten worden verwerkt bij het opnieuw inrichten van een andere IoT Hub.

Eigenschap Waarde
Geaccepteerde waarden: never, reprovisionandmigratedata, reprovisionandresetdata
--resource-group -g

Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--scn --secondary-ca-name --secondary-root-ca-name

De naam van het secundaire basis-CA-certificaat. Als attestation met een basis-CA-certificaat gewenst is, moet er een basis-CA-naam worden opgegeven.

Eigenschap Waarde
Parametergroep: Authentication Arguments
--scp --secondary-certificate-path

Het pad naar het bestand met het secundaire certificaat. Als attestation met een tussencertificaat gewenst is, moet er een certificaatpad worden opgegeven.

Eigenschap Waarde
Parametergroep: Authentication Arguments
--secondary-key --sk

De secundaire symmetrische gedeelde toegangssleutel die is opgeslagen in base64-indeling.

Eigenschap Waarde
Parametergroep: Authentication Arguments
--webhook-url --wh

De url van de Azure Function-webhook die wordt gebruikt voor aangepaste toewijzingsaanvragen.

Eigenschap Waarde
Parametergroep: Allocation Policy Arguments
Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap Waarde
Default value: False

az iot dps enrollment-group delete

Een inschrijvingsgroep verwijderen in een Azure IoT Hub Device Provisioning Service.

az iot dps enrollment-group delete --eid --enrollment-id --gid --group-id
                                   [--auth-type {key, login}]
                                   [--dps-name]
                                   [--etag]
                                   [--login]
                                   [--resource-group]

Vereiste parameters

--eid --enrollment-id --gid --group-id

Id van inschrijvingsgroep.

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--auth-type

Hiermee wordt aangegeven of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. Als het verificatietype aanmelding is en de hostnaam van de resource wordt opgegeven, wordt het opzoeken van resources overgeslagen, tenzij dat nodig is. U kunt de standaardinstelling configureren met behulp van az configure --defaults iotdps-data-auth-type={auth-type-value}.

Eigenschap Waarde
Parametergroep: Access Control Arguments
Default value: key
Geaccepteerde waarden: key, login
--dps-name -n

De naam of hostnaam van de Azure IoT Hub Device Provisioning Service. Vereist als --login niet is opgegeven.

Eigenschap Waarde
Parametergroep: Device Provisioning Service Identifier Arguments
--etag -e

Etag of entiteitstag die overeenkomt met de laatste status van de resource. Als er geen etag wordt opgegeven, wordt de waarde *gebruikt.

--login -l

Deze opdracht ondersteunt een entiteitsverbindingsreeks met rechten om actie uit te voeren. Gebruik dit om sessieaanmelding te voorkomen via 'az login'. Als zowel een entiteitsverbindingsreeks als de naam worden opgegeven, heeft de verbindingsreeks prioriteit. Vereist als --dps-name niet is opgegeven.

Eigenschap Waarde
Parametergroep: Device Provisioning Service Identifier Arguments
--resource-group -g

Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap Waarde
Default value: False

az iot dps enrollment-group list

Registratiegroepen weergeven in een Azure IoT Hub Device Provisioning Service.

az iot dps enrollment-group list [--auth-type {key, login}]
                                 [--dps-name]
                                 [--login]
                                 [--resource-group]
                                 [--top]

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--auth-type

Hiermee wordt aangegeven of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. Als het verificatietype aanmelding is en de hostnaam van de resource wordt opgegeven, wordt het opzoeken van resources overgeslagen, tenzij dat nodig is. U kunt de standaardinstelling configureren met behulp van az configure --defaults iotdps-data-auth-type={auth-type-value}.

Eigenschap Waarde
Parametergroep: Access Control Arguments
Default value: key
Geaccepteerde waarden: key, login
--dps-name -n

De naam of hostnaam van de Azure IoT Hub Device Provisioning Service. Vereist als --login niet is opgegeven.

Eigenschap Waarde
Parametergroep: Device Provisioning Service Identifier Arguments
--login -l

Deze opdracht ondersteunt een entiteitsverbindingsreeks met rechten om actie uit te voeren. Gebruik dit om sessieaanmelding te voorkomen via 'az login'. Als zowel een entiteitsverbindingsreeks als de naam worden opgegeven, heeft de verbindingsreeks prioriteit. Vereist als --dps-name niet is opgegeven.

Eigenschap Waarde
Parametergroep: Device Provisioning Service Identifier Arguments
--resource-group -g

Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--top

Maximum aantal elementen dat moet worden geretourneerd. Gebruik -1 onbeperkt.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap Waarde
Default value: False

az iot dps enrollment-group show

Haal de details van een inschrijvingsgroep op in een Azure IoT Hub Device Provisioning Service.

az iot dps enrollment-group show --eid --enrollment-id --gid --group-id
                                 [--auth-type {key, login}]
                                 [--dps-name]
                                 [--keys --show-keys {false, true}]
                                 [--login]
                                 [--resource-group]

Voorbeelden

Basaal gebruik

az iot dps enrollment-group show --dps-name {dps_name} -g {resource_group} --enrollment-id {enrollment_id}

Volledige attestation-informatie opnemen in resultaten voor een symmetrische sleutelinschrijvingsgroep

az iot dps enrollment-group show --dps-name {dps_name} -g {resource_group} --enrollment-id {symmetric_key_enrollment_id} --show-keys

Vereiste parameters

--eid --enrollment-id --gid --group-id

Id van inschrijvingsgroep.

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--auth-type

Hiermee wordt aangegeven of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. Als het verificatietype aanmelding is en de hostnaam van de resource wordt opgegeven, wordt het opzoeken van resources overgeslagen, tenzij dat nodig is. U kunt de standaardinstelling configureren met behulp van az configure --defaults iotdps-data-auth-type={auth-type-value}.

Eigenschap Waarde
Parametergroep: Access Control Arguments
Default value: key
Geaccepteerde waarden: key, login
--dps-name -n

De naam of hostnaam van de Azure IoT Hub Device Provisioning Service. Vereist als --login niet is opgegeven.

Eigenschap Waarde
Parametergroep: Device Provisioning Service Identifier Arguments
--keys --show-keys

Attestation-sleutels en -informatie opnemen in de resultaten van de inschrijvingsgroep.

Eigenschap Waarde
Geaccepteerde waarden: false, true
--login -l

Deze opdracht ondersteunt een entiteitsverbindingsreeks met rechten om actie uit te voeren. Gebruik dit om sessieaanmelding te voorkomen via 'az login'. Als zowel een entiteitsverbindingsreeks als de naam worden opgegeven, heeft de verbindingsreeks prioriteit. Vereist als --dps-name niet is opgegeven.

Eigenschap Waarde
Parametergroep: Device Provisioning Service Identifier Arguments
--resource-group -g

Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap Waarde
Default value: False

az iot dps enrollment-group update

Werk een inschrijvingsgroep bij in een Azure IoT Hub Device Provisioning Service.

Geef de certificaatindeling op met base64 ASCII-codering en het certificaat moet overeenkomende BEGIN- en END-segmenten hebben, bijvoorbeeld: begin met '-----BEGIN CERTIFICATE-----' en eindig op '-----END CERTIFICATE-----'.

az iot dps enrollment-group update --eid --enrollment-id --gid --group-id
                                   [--allocation-policy --ap {custom, geoLatency, hashed, static}]
                                   [--api-version --av]
                                   [--auth-type {key, login}]
                                   [--ca-name --cn --root-ca-name]
                                   [--certificate-path --cp]
                                   [--cpn --credential-policy-name]
                                   [--dps-name]
                                   [--edge-enabled --ee {false, true}]
                                   [--etag]
                                   [--ih --iot-hubs]
                                   [--initial-twin-properties --props]
                                   [--initial-twin-tags --tags]
                                   [--login]
                                   [--pk --primary-key]
                                   [--provisioning-status --ps {disabled, enabled}]
                                   [--rc --remove-certificate {false, true}]
                                   [--remove-secondary-certificate --rsc {false, true}]
                                   [--reprovision-policy --rp {never, reprovisionandmigratedata, reprovisionandresetdata}]
                                   [--resource-group]
                                   [--scn --secondary-ca-name --secondary-root-ca-name]
                                   [--scp --secondary-certificate-path]
                                   [--secondary-key --sk]
                                   [--webhook-url --wh]

Voorbeelden

Werk de inschrijvingsgroep {enrollment_id} bij in de Azure IoT-inrichtingsservice {dps_name} in de resourcegroep {resource_group_name} met initiële dubbeleigenschappen en eerste dubbeltags.

az iot dps enrollment-group update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --initial-twin-properties "{'location':{'region':'USA'}}" --initial-twin-tags "{'version_dps':'2'}" --etag AAAAAAAAAAA=

Werk de inschrijvingsgroep {enrollment_id} bij in de Azure IoT-inrichtingsservice {dps_name} in de resourcegroep {resource_group_name} met een nieuw primair tussenliggend certificaat en verwijder bestaande secundaire tussenliggende certificaten.

az iot dps enrollment-group update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --certificate-path /certificates/NewCertificate.pem --remove-secondary-certificate --etag AAAAAAAAAAA=

Werk de inschrijvingsgroep {enrollment_id} bij in de Azure IoT-inrichtingsservice {dps_name} in de resourcegroep {resource_group_name} met nieuw secundair CA-certificaat {certificate_name} en verwijder bestaand primair CA-certificaat.

az iot dps enrollment-group update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --secondary-ca-name {certificate_name} --remove-certificate --etag AAAAAAAAAAA=

Werk de inschrijvingsgroep {enrollment_id} bij in de Azure IoT-inrichtingsservice {dps_name} in de resourcegroep {resource_group_name} met nieuwe primaire sleutel.

az iot dps enrollment-group update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --primary-key {new_primary_key} --etag AAAAAAAAAAA=

Werk de inschrijvingsgroep {enrollment_id} bij in de Azure IoT Device Provisioning Service {dps_name} om een aangepast adr-naamruimtereferentiebeleid te gebruiken.

az iot dps enrollment-group update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --credential-policy-name {my_policy}

Vereiste parameters

--eid --enrollment-id --gid --group-id

Id van inschrijvingsgroep.

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--allocation-policy --ap

Type toewijzingsbeleid om te bepalen hoe een apparaat wordt toegewezen aan een IoT Hub. Als dit niet is opgegeven, is het toewijzingsbeleid de standaardinstelling voor het huidige toewijzingsbeleid dat is ingesteld voor het Device Provisioning Service-exemplaar.

Eigenschap Waarde
Parametergroep: Allocation Policy Arguments
Geaccepteerde waarden: custom, geoLatency, hashed, static
--api-version --av

De API-versie van de inrichtingsservicetypen die zijn verzonden in de aangepaste toewijzingsaanvraag. Minimaal ondersteunde versie: 2018-09-01-preview.

Eigenschap Waarde
Parametergroep: Allocation Policy Arguments
--auth-type

Hiermee wordt aangegeven of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. Als het verificatietype aanmelding is en de hostnaam van de resource wordt opgegeven, wordt het opzoeken van resources overgeslagen, tenzij dat nodig is. U kunt de standaardinstelling configureren met behulp van az configure --defaults iotdps-data-auth-type={auth-type-value}.

Eigenschap Waarde
Parametergroep: Access Control Arguments
Default value: key
Geaccepteerde waarden: key, login
--ca-name --cn --root-ca-name

De naam van het primaire basis-CA-certificaat. Als attestation met een basis-CA-certificaat gewenst is, moet er een basis-CA-naam worden opgegeven.

Eigenschap Waarde
Parametergroep: Authentication Arguments
--certificate-path --cp

Het pad naar het bestand met het primaire certificaat. Als attestation met een tussencertificaat gewenst is, moet er een certificaatpad worden opgegeven.

Eigenschap Waarde
Parametergroep: Authentication Arguments
--cpn --credential-policy-name

Naam van adr-naamruimtereferentiebeleid.

Eigenschap Waarde
Parametergroep: ADR Credential Policy Arguments
--dps-name -n

De naam of hostnaam van de Azure IoT Hub Device Provisioning Service. Vereist als --login niet is opgegeven.

Eigenschap Waarde
Parametergroep: Device Provisioning Service Identifier Arguments
--edge-enabled --ee

Vlag die aangeeft dat edge is ingeschakeld.

Eigenschap Waarde
Geaccepteerde waarden: false, true
--etag -e

Etag of entiteitstag die overeenkomt met de laatste status van de resource. Als er geen etag wordt opgegeven, wordt de waarde *gebruikt.

--ih --iot-hubs

Hostnaam van de doel-IoT Hub die is gekoppeld aan het toewijzingsbeleid. Gebruik een door spaties gescheiden lijst voor meerdere IoT Hubs.

Eigenschap Waarde
Parametergroep: Allocation Policy Arguments
--initial-twin-properties --props

Initiële eigenschappen van apparaatdubbels.

--initial-twin-tags --tags

Eerste tags voor apparaatdubbels.

--login -l

Deze opdracht ondersteunt een entiteitsverbindingsreeks met rechten om actie uit te voeren. Gebruik dit om sessieaanmelding te voorkomen via 'az login'. Als zowel een entiteitsverbindingsreeks als de naam worden opgegeven, heeft de verbindingsreeks prioriteit. Vereist als --dps-name niet is opgegeven.

Eigenschap Waarde
Parametergroep: Device Provisioning Service Identifier Arguments
--pk --primary-key

De primaire symmetrische gedeelde toegangssleutel die is opgeslagen in base64-indeling.

Eigenschap Waarde
Parametergroep: Authentication Arguments
--provisioning-status --ps

Inschrijvingsvermelding in- of uitschakelen.

Eigenschap Waarde
Geaccepteerde waarden: disabled, enabled
--rc --remove-certificate

Vlag om het huidige primaire certificaat te verwijderen.

Eigenschap Waarde
Parametergroep: Authentication Arguments
Geaccepteerde waarden: false, true
--remove-secondary-certificate --rsc

Vlag om het huidige secundaire certificaat te verwijderen.

Eigenschap Waarde
Parametergroep: Authentication Arguments
Geaccepteerde waarden: false, true
--reprovision-policy --rp

Beleid om te bepalen hoe apparaatgegevens moeten worden verwerkt bij het opnieuw inrichten van een andere IoT Hub.

Eigenschap Waarde
Geaccepteerde waarden: never, reprovisionandmigratedata, reprovisionandresetdata
--resource-group -g

Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--scn --secondary-ca-name --secondary-root-ca-name

De naam van het secundaire basis-CA-certificaat. Als attestation met een basis-CA-certificaat gewenst is, moet er een basis-CA-naam worden opgegeven.

Eigenschap Waarde
Parametergroep: Authentication Arguments
--scp --secondary-certificate-path

Het pad naar het bestand met het secundaire certificaat. Als attestation met een tussencertificaat gewenst is, moet er een certificaatpad worden opgegeven.

Eigenschap Waarde
Parametergroep: Authentication Arguments
--secondary-key --sk

De secundaire symmetrische gedeelde toegangssleutel die is opgeslagen in base64-indeling.

Eigenschap Waarde
Parametergroep: Authentication Arguments
--webhook-url --wh

De url van de Azure Function-webhook die wordt gebruikt voor aangepaste toewijzingsaanvragen.

Eigenschap Waarde
Parametergroep: Allocation Policy Arguments
Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap Waarde
Default value: False