az iot central enrollment-group

Kommentar

Den här referensen är en del av azure-iot-tillägget för Azure CLI (version 2.37.0 eller senare). Tillägget installeras automatiskt första gången du kör kommandot az iot central enrollment-group . Läs mer om tillägg.

Hantera och konfigurera IoT Central-registreringsgrupp.

Kommandon

Name Description Typ Status
az iot central enrollment-group create

Skapa en registreringsgrupp.

Anknytning Allmän tillgänglighet
az iot central enrollment-group delete

Ta bort en registreringsgrupp efter ID.

Anknytning Allmän tillgänglighet
az iot central enrollment-group generate-verification-code

Generera en verifieringskod för det primära eller sekundära x509-certifikatet för en registreringsgrupp.

Anknytning Allmän tillgänglighet
az iot central enrollment-group list

Hämta listan över registreringsgrupper i ett program.

Anknytning Allmän tillgänglighet
az iot central enrollment-group show

Få information om en registreringsgrupp efter ID.

Anknytning Allmän tillgänglighet
az iot central enrollment-group update

Uppdatera en registreringsgrupp.

Anknytning Allmän tillgänglighet
az iot central enrollment-group verify-certificate

Verifiera det primära eller sekundära x509-certifikatet för en registreringsgrupp.

Anknytning Allmän tillgänglighet

az iot central enrollment-group create

Skapa en registreringsgrupp.

az iot central enrollment-group create --app-id
                                       --at {symmetricKey, x509}
                                       --display-name
                                       --group-id
                                       --type
                                       [--api-version {2022-06-30-preview, 2022-07-31}]
                                       [--central-api-uri]
                                       [--certificate-path]
                                       [--etag]
                                       [--pk]
                                       [--provisioning-status {disabled, enabled}]
                                       [--scp]
                                       [--secondary-key]
                                       [--token]

Exempel

Skapa en registreringsgrupp

az iot central enrollment-group create --app-id {appid} --id {enrollmentGroupId} --at {attestation} --display-name {displayName} --type {type}

Skapa en registreringsgrupp med x509-primär certifiering

az iot central enrollment-group create --app-id {appid} --id {enrollmentGroupId} --at 'x509' --display-name {displayName} --type {type} --cp {primayCertPath}

Skapa en registreringsgrupp med angiven symmetrisk nyckelcertifiering

az iot central enrollment-group create --app-id {appid} --id {enrollmentGroupId} --at 'symmetricKey' --display-name {displayName} --type {type} --pk {primaryKey} --sk {secondaryKey}

Obligatoriska parametrar

--app-id -n

App-ID för den IoT Central-app som du vill hantera. Du hittar app-ID:t på sidan "Om" för ditt program under hjälpmenyn.

--at --attestation-type

Attesteringsmekanismen för registreringsgruppen. Endast "x509" eller "symmetricKey" tillåts. Som standard används "symmetricKey" för attestering.

accepterade värden: symmetricKey, x509
standardvärde: symmetricKey
--display-name

Visningsnamn för registreringsgruppen.

--group-id --id

Unik identifierare för registreringsgruppen.

--type

Typ av enheter som ansluter via gruppen.

Valfria parametrar

--api-version --av
Inaktuell

Argumentet "api_version" har blivit inaktuellt och tas bort i en framtida version.

Den här kommandoparametern är inaktuell och ignoreras. I den framtida versionen stöder vi endast IoT Central-API:er från den senaste GA-versionen. Om något API inte är GA ännu anropar vi den senaste förhandsversionen.

accepterade värden: 2022-06-30-preview, 2022-07-31
standardvärde: 2022-07-31
--central-api-uri --central-dns-suffix

IoT Central DNS-suffixet som är associerat med ditt program.

standardvärde: azureiotcentral.com
--certificate-path --cp

Sökvägen till filen som innehåller det primära certifikatet.

--etag -e

Etag eller entitetstagg som motsvarar resursens sista tillstånd. Om ingen etag anges används värdet *.

--pk --primary-key

Den primära symmetriska delade åtkomstnyckeln som lagras i base64-format.

--provisioning-status --ps

Om enheterna som använder gruppen tillåts ansluta till IoT Central. Sant eller Falskt.

accepterade värden: disabled, enabled
standardvärde: enabled
--scp --secondary-certificate-path

Sökvägen till filen som innehåller det sekundära certifikatet.

--secondary-key --sk

Den sekundära symmetriska delade åtkomstnyckeln som lagras i base64-format.

--token

Om du föredrar att skicka din begäran utan att autentisera mot Azure CLI kan du ange en giltig användartoken för att autentisera din begäran. Du måste ange typ av nyckel som en del av begäran. Läs mer på https://aka.ms/iotcentraldocsapi.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az iot central enrollment-group delete

Ta bort en registreringsgrupp efter ID.

az iot central enrollment-group delete --app-id
                                       --group-id
                                       [--api-version {2022-06-30-preview, 2022-07-31}]
                                       [--central-api-uri]
                                       [--token]

Exempel

Ta bort en registreringsgrupp efter ID

az iot central enrollment-group delete --app-id {appid} --id {enrollmentGroupId}

Obligatoriska parametrar

--app-id -n

App-ID för den IoT Central-app som du vill hantera. Du hittar app-ID:t på sidan "Om" för ditt program under hjälpmenyn.

--group-id --id

Unik identifierare för registreringsgruppen.

Valfria parametrar

--api-version --av
Inaktuell

Argumentet "api_version" har blivit inaktuellt och tas bort i en framtida version.

Den här kommandoparametern är inaktuell och ignoreras. I den framtida versionen stöder vi endast IoT Central-API:er från den senaste GA-versionen. Om något API inte är GA ännu anropar vi den senaste förhandsversionen.

accepterade värden: 2022-06-30-preview, 2022-07-31
standardvärde: 2022-07-31
--central-api-uri --central-dns-suffix

IoT Central DNS-suffixet som är associerat med ditt program.

standardvärde: azureiotcentral.com
--token

Om du föredrar att skicka din begäran utan att autentisera mot Azure CLI kan du ange en giltig användartoken för att autentisera din begäran. Du måste ange typ av nyckel som en del av begäran. Läs mer på https://aka.ms/iotcentraldocsapi.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az iot central enrollment-group generate-verification-code

Generera en verifieringskod för det primära eller sekundära x509-certifikatet för en registreringsgrupp.

az iot central enrollment-group generate-verification-code --app-id
                                                           --group-id
                                                           [--api-version {2022-06-30-preview, 2022-07-31}]
                                                           [--central-api-uri]
                                                           [--certificate-entry {primary, secondary}]
                                                           [--token]

Exempel

Generera en verifieringskod för det primära x509-certifikatet för en registreringsgrupp

az iot central enrollment-group generate-verification-code --app-id {appid} --id {enrollmentGroupId} --entry 'primary'

Obligatoriska parametrar

--app-id -n

App-ID för den IoT Central-app som du vill hantera. Du hittar app-ID:t på sidan "Om" för ditt program under hjälpmenyn.

--group-id --id

Unik identifierare för registreringsgruppen.

Valfria parametrar

--api-version --av
Inaktuell

Argumentet "api_version" har blivit inaktuellt och tas bort i en framtida version.

Den här kommandoparametern är inaktuell och ignoreras. I den framtida versionen stöder vi endast IoT Central-API:er från den senaste GA-versionen. Om något API inte är GA ännu anropar vi den senaste förhandsversionen.

accepterade värden: 2022-06-30-preview, 2022-07-31
standardvärde: 2022-07-31
--central-api-uri --central-dns-suffix

IoT Central DNS-suffixet som är associerat med ditt program.

standardvärde: azureiotcentral.com
--certificate-entry --entry

Posttyp för x509-certifikatet som endast tillåter "primär" och "sekundär".

accepterade värden: primary, secondary
--token

Om du föredrar att skicka din begäran utan att autentisera mot Azure CLI kan du ange en giltig användartoken för att autentisera din begäran. Du måste ange typ av nyckel som en del av begäran. Läs mer på https://aka.ms/iotcentraldocsapi.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az iot central enrollment-group list

Hämta listan över registreringsgrupper i ett program.

az iot central enrollment-group list --app-id
                                     [--api-version {2022-06-30-preview, 2022-07-31}]
                                     [--central-api-uri]
                                     [--token]

Exempel

Hämta listan över registreringsgrupper i ett program

az iot central enrollment-group list --app-id {appid}

Obligatoriska parametrar

--app-id -n

App-ID för den IoT Central-app som du vill hantera. Du hittar app-ID:t på sidan "Om" för ditt program under hjälpmenyn.

Valfria parametrar

--api-version --av
Inaktuell

Argumentet "api_version" har blivit inaktuellt och tas bort i en framtida version.

Den här kommandoparametern är inaktuell och ignoreras. I den framtida versionen stöder vi endast IoT Central-API:er från den senaste GA-versionen. Om något API inte är GA ännu anropar vi den senaste förhandsversionen.

accepterade värden: 2022-06-30-preview, 2022-07-31
standardvärde: 2022-07-31
--central-api-uri --central-dns-suffix

IoT Central DNS-suffixet som är associerat med ditt program.

standardvärde: azureiotcentral.com
--token

Om du föredrar att skicka din begäran utan att autentisera mot Azure CLI kan du ange en giltig användartoken för att autentisera din begäran. Du måste ange typ av nyckel som en del av begäran. Läs mer på https://aka.ms/iotcentraldocsapi.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az iot central enrollment-group show

Få information om en registreringsgrupp efter ID.

az iot central enrollment-group show --app-id
                                     --group-id
                                     [--api-version {2022-06-30-preview, 2022-07-31}]
                                     [--central-api-uri]
                                     [--certificate-entry {primary, secondary}]
                                     [--token]

Exempel

Få information om en registreringsgrupp efter ID

az iot central enrollment-group show --app-id {appid} --id {enrollmentGroupId}

Obligatoriska parametrar

--app-id -n

App-ID för den IoT Central-app som du vill hantera. Du hittar app-ID:t på sidan "Om" för ditt program under hjälpmenyn.

--group-id --id

Unik identifierare för registreringsgruppen.

Valfria parametrar

--api-version --av
Inaktuell

Argumentet "api_version" har blivit inaktuellt och tas bort i en framtida version.

Den här kommandoparametern är inaktuell och ignoreras. I den framtida versionen stöder vi endast IoT Central-API:er från den senaste GA-versionen. Om något API inte är GA ännu anropar vi den senaste förhandsversionen.

accepterade värden: 2022-06-30-preview, 2022-07-31
standardvärde: 2022-07-31
--central-api-uri --central-dns-suffix

IoT Central DNS-suffixet som är associerat med ditt program.

standardvärde: azureiotcentral.com
--certificate-entry --entry

Posttyp för x509-certifikatet som endast tillåter "primär" och "sekundär".

accepterade värden: primary, secondary
--token

Om du föredrar att skicka din begäran utan att autentisera mot Azure CLI kan du ange en giltig användartoken för att autentisera din begäran. Du måste ange typ av nyckel som en del av begäran. Läs mer på https://aka.ms/iotcentraldocsapi.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az iot central enrollment-group update

Uppdatera en registreringsgrupp.

az iot central enrollment-group update --app-id
                                       --group-id
                                       [--api-version {2022-06-30-preview, 2022-07-31}]
                                       [--central-api-uri]
                                       [--certificate-entry {primary, secondary}]
                                       [--certificate-path]
                                       [--display-name]
                                       [--etag]
                                       [--provisioning-status {disabled, enabled}]
                                       [--remove-x509 {false, true}]
                                       [--scp]
                                       [--token]
                                       [--type]

Exempel

Uppdatera en registreringsgrupp

az iot central enrollment-group update --app-id {appid} --id {enrollmentGroupId} --display-name {displayName} --type {type} --ps {enabled}

Ta bort x509-primärt certifikat från en registreringsgrupp

az iot central enrollment-group update --app-id {appid} --id {enrollmentGroupId} --remove-x509 'true' --entry 'primary'

Obligatoriska parametrar

--app-id -n

App-ID för den IoT Central-app som du vill hantera. Du hittar app-ID:t på sidan "Om" för ditt program under hjälpmenyn.

--group-id --id

Unik identifierare för registreringsgruppen.

Valfria parametrar

--api-version --av
Inaktuell

Argumentet "api_version" har blivit inaktuellt och tas bort i en framtida version.

Den här kommandoparametern är inaktuell och ignoreras. I den framtida versionen stöder vi endast IoT Central-API:er från den senaste GA-versionen. Om något API inte är GA ännu anropar vi den senaste förhandsversionen.

accepterade värden: 2022-06-30-preview, 2022-07-31
standardvärde: 2022-07-31
--central-api-uri --central-dns-suffix

IoT Central DNS-suffixet som är associerat med ditt program.

standardvärde: azureiotcentral.com
--certificate-entry --entry

Posttyp för x509-certifikatet som endast tillåter "primär" och "sekundär".

accepterade värden: primary, secondary
--certificate-path --cp

Sökvägen till filen som innehåller det primära certifikatet.

--display-name

Visningsnamn för registreringsgruppen.

--etag

ETag används för att förhindra konflikter i uppdateringar av registreringsgrupper.

--provisioning-status --ps

Om enheterna som använder gruppen tillåts ansluta till IoT Central. Sant eller Falskt.

accepterade värden: disabled, enabled
standardvärde: enabled
--remove-x509

Om x509-certifikatet ska tas bort från gruppen. Sant eller Falskt.

accepterade värden: false, true
--scp --secondary-certificate-path

Sökvägen till filen som innehåller det sekundära certifikatet.

--token

Om du föredrar att skicka din begäran utan att autentisera mot Azure CLI kan du ange en giltig användartoken för att autentisera din begäran. Du måste ange typ av nyckel som en del av begäran. Läs mer på https://aka.ms/iotcentraldocsapi.

--type

Typ av enheter som ansluter via gruppen.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az iot central enrollment-group verify-certificate

Verifiera det primära eller sekundära x509-certifikatet för en registreringsgrupp.

Verifiera det primära eller sekundära x509-certifikatet för en registreringsgrupp genom att ange ett certifikat med den signerade verifieringskoden.

Observera att om en registreringsgrupp skapades med ett overifierat x509-certifikat måste ett verifieringscertifikat skapas med det overifierade x509-certifikatet och en verifieringskod innan du använder det här kommandot. En verifieringskod kan genereras via cli med kommandot "enrollment-group generate-verification-code". Läs mer om hur du skapar verifieringscertifikat med hjälp av verifieringskod på https://learn.microsoft.com/en-us/azure/iot-central/core/how-to-connect-devices-x509.

az iot central enrollment-group verify-certificate --app-id
                                                   --group-id
                                                   [--api-version {2022-06-30-preview, 2022-07-31}]
                                                   [--central-api-uri]
                                                   [--certificate-path]
                                                   [--scp]
                                                   [--token]

Exempel

Verifiera det primära x509-certifikatet för en registreringsgrupp

az iot central enrollment-group verify-certificate --app-id {appid} --id {enrollmentGroupId} --cp {primayCertPath}

Obligatoriska parametrar

--app-id -n

App-ID för den IoT Central-app som du vill hantera. Du hittar app-ID:t på sidan "Om" för ditt program under hjälpmenyn.

--group-id --id

Unik identifierare för registreringsgruppen.

Valfria parametrar

--api-version --av
Inaktuell

Argumentet "api_version" har blivit inaktuellt och tas bort i en framtida version.

Den här kommandoparametern är inaktuell och ignoreras. I den framtida versionen stöder vi endast IoT Central-API:er från den senaste GA-versionen. Om något API inte är GA ännu anropar vi den senaste förhandsversionen.

accepterade värden: 2022-06-30-preview, 2022-07-31
standardvärde: 2022-07-31
--central-api-uri --central-dns-suffix

IoT Central DNS-suffixet som är associerat med ditt program.

standardvärde: azureiotcentral.com
--certificate-path --cp

Sökvägen till filen som innehåller det primära certifikatet.

--scp --secondary-certificate-path

Sökvägen till filen som innehåller det sekundära certifikatet.

--token

Om du föredrar att skicka din begäran utan att autentisera mot Azure CLI kan du ange en giltig användartoken för att autentisera din begäran. Du måste ange typ av nyckel som en del av begäran. Läs mer på https://aka.ms/iotcentraldocsapi.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.