az iot central enrollment-group

Odwołanie

Uwaga

Ta dokumentacja jest częścią rozszerzenia azure-iot dla interfejsu wiersza polecenia platformy Azure (wersja 2.46.0 lub nowsza). Rozszerzenie zostanie automatycznie zainstalowane przy pierwszym uruchomieniu polecenia az iot central enrollment-group . Dowiedz się więcej o rozszerzeniach.

Zarządzanie i konfigurowanie grupy rejestracji usługi IoT Central.

Polecenia

Nazwa	Opis	Typ	Stan
az iot central enrollment-group create	Utwórz grupę rejestracji.	Numer wewnętrzny	Ogólna dostępność
az iot central enrollment-group delete	Usuń grupę rejestracji według identyfikatora.	Numer wewnętrzny	Ogólna dostępność
az iot central enrollment-group generate-verification-code	Wygeneruj kod weryfikacyjny dla certyfikatu podstawowego lub pomocniczego x509 grupy rejestracji.	Numer wewnętrzny	Ogólna dostępność
az iot central enrollment-group list	Pobierz listę grup rejestracji w aplikacji.	Numer wewnętrzny	Ogólna dostępność
az iot central enrollment-group show	Uzyskaj szczegółowe informacje o grupie rejestracji według identyfikatora.	Numer wewnętrzny	Ogólna dostępność
az iot central enrollment-group update	Zaktualizuj grupę rejestracji.	Numer wewnętrzny	Ogólna dostępność
az iot central enrollment-group verify-certificate	Sprawdź podstawowy lub pomocniczy certyfikat x509 grupy rejestracji.	Numer wewnętrzny	Ogólna dostępność

az iot central enrollment-group create

Utwórz grupę rejestracji.

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]

Przykłady

Tworzenie grupy rejestracji

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

Tworzenie grupy rejestracji z certyfikatem podstawowym x509

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

Tworzenie grupy rejestracji z danym certyfikatem klucza symetrycznego

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

Parametry wymagane

--app-id -n

Identyfikator aplikacji usługi IoT Central, którą chcesz zarządzać. Identyfikator aplikacji można znaleźć na stronie "Informacje" dla aplikacji w menu pomocy.

--at --attestation-type

Mechanizm zaświadczania dla grupy rejestracji. Dozwolone są tylko wartości "x509" lub "symmetricKey". Domyślnie "symmetricKey" będzie używany do zaświadczania.

Dopuszczalne wartości: symmetricKey, x509

Domyślna wartość: symmetricKey

--display-name

Nazwa wyświetlana grupy rejestracji.

--group-id --id

Unikatowy identyfikator grupy rejestracji.

--type

Typ urządzeń łączących się za pośrednictwem grupy.

Parametry opcjonalne

--api-version --av

Przestarzałe

Argument "api_version" został wycofany i zostanie usunięty w przyszłej wersji.

Ten parametr polecenia został przestarzały i zostanie zignorowany. W przyszłej wersji będziemy obsługiwać tylko interfejsy API usługi IoT Central z najnowszej wersji ogólnie dostępnej. Jeśli jakikolwiek interfejs API nie jest jeszcze ogólnie dostępny, wywołamy najnowszą wersję zapoznawcza.

Dopuszczalne wartości: 2022-06-30-preview, 2022-07-31

Domyślna wartość: 2022-07-31

--central-api-uri --central-dns-suffix

Sufiks DNS usługi IoT Central skojarzony z aplikacją.

Domyślna wartość: azureiotcentral.com

--certificate-path --cp

Ścieżka do pliku zawierającego certyfikat podstawowy.

--etag -e

Etag lub tag jednostki odpowiadający ostatniemu stanowi zasobu. Jeśli nie podano elementu etag, zostanie użyta wartość "*".

--pk --primary-key

Podstawowy symetryczny klucz dostępu współdzielonego przechowywany w formacie base64.

--provisioning-status --ps

Czy urządzenia korzystające z grupy mogą łączyć się z usługą IoT Central. Prawda czy fałsz?

Dopuszczalne wartości: disabled, enabled

Domyślna wartość: enabled

--scp --secondary-certificate-path

Ścieżka do pliku zawierającego certyfikat pomocniczy.

--secondary-key --sk

Pomocniczy symetryczny klucz dostępu współdzielonego przechowywany w formacie base64.

--token

Jeśli wolisz przesłać żądanie bez uwierzytelniania w interfejsie wiersza polecenia platformy Azure, możesz określić prawidłowy token użytkownika w celu uwierzytelnienia żądania. Musisz określić typ klucza w ramach żądania. Dowiedz się więcej na https://aka.ms/iotcentraldocsapi.

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc

Domyślna wartość: json

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

az iot central enrollment-group delete

Usuń grupę rejestracji według identyfikatora.

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

Przykłady

Usuwanie grupy rejestracji według identyfikatora

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

Parametry wymagane

--app-id -n

Identyfikator aplikacji usługi IoT Central, którą chcesz zarządzać. Identyfikator aplikacji można znaleźć na stronie "Informacje" dla aplikacji w menu pomocy.

--group-id --id

Unikatowy identyfikator grupy rejestracji.

Parametry opcjonalne

--api-version --av

Przestarzałe

Argument "api_version" został wycofany i zostanie usunięty w przyszłej wersji.

Dopuszczalne wartości: 2022-06-30-preview, 2022-07-31

Domyślna wartość: 2022-07-31

--central-api-uri --central-dns-suffix

Sufiks DNS usługi IoT Central skojarzony z aplikacją.

Domyślna wartość: azureiotcentral.com

--token

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc

Domyślna wartość: json

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

az iot central enrollment-group generate-verification-code

Wygeneruj kod weryfikacyjny dla certyfikatu podstawowego lub pomocniczego x509 grupy rejestracji.

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]

Przykłady

Generowanie kodu weryfikacyjnego podstawowego certyfikatu x509 grupy rejestracji

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

Parametry wymagane

--app-id -n

Identyfikator aplikacji usługi IoT Central, którą chcesz zarządzać. Identyfikator aplikacji można znaleźć na stronie "Informacje" dla aplikacji w menu pomocy.

--group-id --id

Unikatowy identyfikator grupy rejestracji.

Parametry opcjonalne

--api-version --av

Przestarzałe

Argument "api_version" został wycofany i zostanie usunięty w przyszłej wersji.

Dopuszczalne wartości: 2022-06-30-preview, 2022-07-31

Domyślna wartość: 2022-07-31

--central-api-uri --central-dns-suffix

Sufiks DNS usługi IoT Central skojarzony z aplikacją.

Domyślna wartość: azureiotcentral.com

--certificate-entry --entry

Typ wpisu certyfikatu x509, który zezwala tylko na "podstawowy" i "pomocniczy".

Dopuszczalne wartości: primary, secondary

--token

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc

Domyślna wartość: json

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

az iot central enrollment-group list

Pobierz listę grup rejestracji w aplikacji.

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

Przykłady

Pobieranie listy grup rejestracji w aplikacji

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

Parametry wymagane

--app-id -n

Identyfikator aplikacji usługi IoT Central, którą chcesz zarządzać. Identyfikator aplikacji można znaleźć na stronie "Informacje" dla aplikacji w menu pomocy.

Parametry opcjonalne

--api-version --av

Przestarzałe

Argument "api_version" został wycofany i zostanie usunięty w przyszłej wersji.

Dopuszczalne wartości: 2022-06-30-preview, 2022-07-31

Domyślna wartość: 2022-07-31

--central-api-uri --central-dns-suffix

Sufiks DNS usługi IoT Central skojarzony z aplikacją.

Domyślna wartość: azureiotcentral.com

--token

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc

Domyślna wartość: json

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

az iot central enrollment-group show

Uzyskaj szczegółowe informacje o grupie rejestracji według identyfikatora.

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]

Przykłady

Uzyskiwanie szczegółowych informacji o grupie rejestracji według identyfikatora

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

Parametry wymagane

--app-id -n

Identyfikator aplikacji usługi IoT Central, którą chcesz zarządzać. Identyfikator aplikacji można znaleźć na stronie "Informacje" dla aplikacji w menu pomocy.

--group-id --id

Unikatowy identyfikator grupy rejestracji.

Parametry opcjonalne

--api-version --av

Przestarzałe

Argument "api_version" został wycofany i zostanie usunięty w przyszłej wersji.

Dopuszczalne wartości: 2022-06-30-preview, 2022-07-31

Domyślna wartość: 2022-07-31

--central-api-uri --central-dns-suffix

Sufiks DNS usługi IoT Central skojarzony z aplikacją.

Domyślna wartość: azureiotcentral.com

--certificate-entry --entry

Typ wpisu certyfikatu x509, który zezwala tylko na "podstawowy" i "pomocniczy".

Dopuszczalne wartości: primary, secondary

--token

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc

Domyślna wartość: json

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

az iot central enrollment-group update

Zaktualizuj grupę rejestracji.

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]

Przykłady

Aktualizowanie grupy rejestracji

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

Usuwanie certyfikatu podstawowego x509 z grupy rejestracji

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

Parametry wymagane

--app-id -n

Identyfikator aplikacji usługi IoT Central, którą chcesz zarządzać. Identyfikator aplikacji można znaleźć na stronie "Informacje" dla aplikacji w menu pomocy.

--group-id --id

Unikatowy identyfikator grupy rejestracji.

Parametry opcjonalne

--api-version --av

Przestarzałe

Argument "api_version" został wycofany i zostanie usunięty w przyszłej wersji.

Dopuszczalne wartości: 2022-06-30-preview, 2022-07-31

Domyślna wartość: 2022-07-31

--central-api-uri --central-dns-suffix

Sufiks DNS usługi IoT Central skojarzony z aplikacją.

Domyślna wartość: azureiotcentral.com

--certificate-entry --entry

Typ wpisu certyfikatu x509, który zezwala tylko na "podstawowy" i "pomocniczy".

Dopuszczalne wartości: primary, secondary

--certificate-path --cp

Ścieżka do pliku zawierającego certyfikat podstawowy.

--display-name

Nazwa wyświetlana grupy rejestracji.

--etag

Element ETag używany do zapobiegania konfliktom w aktualizacjach grupy rejestracji.

--provisioning-status --ps

Czy urządzenia korzystające z grupy mogą łączyć się z usługą IoT Central. Prawda czy fałsz?

Dopuszczalne wartości: disabled, enabled

Domyślna wartość: enabled

--remove-x509

Czy certyfikat x509 powinien zostać usunięty z grupy. Prawda czy fałsz?

Dopuszczalne wartości: false, true

--scp --secondary-certificate-path

Ścieżka do pliku zawierającego certyfikat pomocniczy.

--token

--type

Typ urządzeń łączących się za pośrednictwem grupy.

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc

Domyślna wartość: json

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

az iot central enrollment-group verify-certificate

Sprawdź podstawowy lub pomocniczy certyfikat x509 grupy rejestracji.

Sprawdź podstawowy lub pomocniczy certyfikat x509 grupy rejestracji, podając certyfikat z podpisanym kodem weryfikacyjnym.

Należy pamiętać, że jeśli grupa rejestracji została utworzona przy użyciu niezweryfikowanego certyfikatu x509, przed użyciem tego polecenia należy utworzyć certyfikat weryfikacji przy użyciu niezweryfikowanego certyfikatu x509 i kodu weryfikacyjnego. Kod weryfikacyjny można wygenerować za pomocą interfejsu wiersza polecenia przy użyciu polecenia "enrollment-group generate-verification-code". Dowiedz się więcej na temat tworzenia certyfikatów weryfikacji przy użyciu kodu weryfikacyjnego na stronie 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]

Przykłady

Weryfikowanie podstawowego certyfikatu x509 grupy rejestracji

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

Parametry wymagane

--app-id -n

Identyfikator aplikacji usługi IoT Central, którą chcesz zarządzać. Identyfikator aplikacji można znaleźć na stronie "Informacje" dla aplikacji w menu pomocy.

--group-id --id

Unikatowy identyfikator grupy rejestracji.

Parametry opcjonalne

--api-version --av

Przestarzałe

Argument "api_version" został wycofany i zostanie usunięty w przyszłej wersji.

Dopuszczalne wartości: 2022-06-30-preview, 2022-07-31

Domyślna wartość: 2022-07-31

--central-api-uri --central-dns-suffix

Sufiks DNS usługi IoT Central skojarzony z aplikacją.

Domyślna wartość: azureiotcentral.com

--certificate-path --cp

Ścieżka do pliku zawierającego certyfikat podstawowy.

--scp --secondary-certificate-path

Ścieżka do pliku zawierającego certyfikat pomocniczy.

--token

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc

Domyślna wartość: json

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Udostępnij za pośrednictwem

az iot central enrollment-group

Polecenia

az iot central enrollment-group create

Przykłady

Parametry wymagane

Parametry opcjonalne

az iot central enrollment-group delete

Przykłady

Parametry wymagane

Parametry opcjonalne

az iot central enrollment-group generate-verification-code

Przykłady

Parametry wymagane

Parametry opcjonalne

az iot central enrollment-group list

Przykłady

Parametry wymagane

Parametry opcjonalne

az iot central enrollment-group show

Przykłady

Parametry wymagane

Parametry opcjonalne

az iot central enrollment-group update

Przykłady

Parametry wymagane

Parametry opcjonalne

az iot central enrollment-group verify-certificate

Przykłady

Parametry wymagane

Parametry opcjonalne

Dodatkowe zasoby