az iot central user

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 user . Dowiedz się więcej o rozszerzeniach.

Zarządzanie użytkownikami usługi IoT Central i konfigurowanie ich.

Polecenia

Nazwa	Opis	Typ	Stan
az iot central user create	Dodaj użytkownika do aplikacji.	Numer wewnętrzny	Ogólna dostępność
az iot central user delete	Usuń użytkownika z aplikacji.	Numer wewnętrzny	Ogólna dostępność
az iot central user list	Pobierz listę użytkowników dla aplikacji usługi IoT Central.	Numer wewnętrzny	Ogólna dostępność
az iot central user show	Uzyskaj szczegółowe informacje o użytkowniku według identyfikatora.	Numer wewnętrzny	Ogólna dostępność
az iot central user update	Aktualizowanie ról użytkownika w aplikacji.	Numer wewnętrzny	Ogólna dostępność

az iot central user create

Dodaj użytkownika do aplikacji.

az iot central user create --app-id
                           --assignee
                           --role
                           [--api-version {2022-06-30-preview, 2022-07-31}]
                           [--central-api-uri]
                           [--email]
                           [--object-id]
                           [--org-id]
                           [--tenant-id]
                           [--token]

Przykłady

Dodawanie użytkownika pocztą e-mail do aplikacji

az iot central user create --user-id {userId} --app-id {appId} --email {emailAddress} --role admin

Dodawanie jednostki usługi do aplikacji

az iot central user create --user-id {userId} --app-id {appId} --tenant-id {tenantId} --object-id {objectId} --role operator

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.

--assignee --user-id

Identyfikator skojarzony z użytkownikiem.

--role -r

Rola, która zostanie skojarzona z tym tokenem lub użytkownikiem. Możesz określić jedną z wbudowanych ról lub określić identyfikator roli niestandardowej. Zobacz więcej na stronie https://aka.ms/iotcentral-customrolesdocs.

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

--email

Adres e-mail użytkownika, który ma zostać dodany do aplikacji. Jeśli zostanie to określone, parametry jednostki usługi (tenant_id i object_id) zostaną zignorowane.

--object-id --oid

Identyfikator obiektu dla jednostki usługi, która ma zostać dodana do aplikacji. Należy również określić identyfikator dzierżawy. Jeśli zostanie określona wiadomość e-mail, zostanie ona zignorowana, a użytkownik nie będzie użytkownikiem jednostki usługi, ale standardowym użytkownikiem "e-mail".

--org-id --organization-id

Identyfikator organizacji dla przypisania roli użytkownika. Dostępne tylko dla interfejsu API-version == 1.1-preview.

--tenant-id --tnid

Identyfikator dzierżawy dla jednostki usługi, która ma zostać dodana do aplikacji. Należy również określić identyfikator obiektu. Jeśli zostanie określona wiadomość e-mail, zostanie ona zignorowana, a użytkownik nie będzie użytkownikiem jednostki usługi, ale standardowym użytkownikiem "e-mail".

--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 user delete

Usuń użytkownika z aplikacji.

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

Przykłady

Usuwanie użytkownika

az iot central user delete --app-id {appid} --user-id {userId}

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.

--assignee --user-id

Identyfikator skojarzony z użytkownikiem.

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

--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 user list

Pobierz listę użytkowników dla aplikacji usługi IoT Central.

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

Przykłady

Lista użytkowników

az iot central user 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.

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

--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 user show

Uzyskaj szczegółowe informacje o użytkowniku według identyfikatora.

az iot central user show --app-id
                         --assignee
                         [--api-version {2022-06-30-preview, 2022-07-31}]
                         [--central-api-uri]
                         [--token]

Przykłady

Uzyskiwanie szczegółów użytkownika

az iot central user show --app-id {appid} --user-id {userId}

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.

--assignee --user-id

Identyfikator skojarzony z użytkownikiem.

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

--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 user update

Aktualizowanie ról użytkownika w aplikacji.

Zaktualizuj użytkownika przy użyciu różnych ról. Aktualizowanie identyfikatora tenantId lub objectId dla użytkownika jednostki usługi jest niedozwolone. Aktualizowanie adresu e-mail użytkownika poczty e-mail jest niedozwolone.

az iot central user update --app-id
                           --assignee
                           [--api-version {2022-06-30-preview, 2022-07-31}]
                           [--central-api-uri]
                           [--email]
                           [--object-id]
                           [--roles]
                           [--tenant-id]
                           [--token]

Przykłady

Aktualizowanie ról użytkownika za pomocą poczty e-mail lub jednostki usługi w aplikacji.

az iot central user update --user-id {userId} --app-id {appId} --roles "org1\admin"

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.

--assignee --user-id

Identyfikator skojarzony z użytkownikiem.

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

--email

Adres e-mail użytkownika, który ma zostać dodany do aplikacji. Jeśli zostanie to określone, parametry jednostki usługi (tenant_id i object_id) zostaną zignorowane.

--object-id --oid

Identyfikator obiektu dla jednostki usługi, która ma zostać dodana do aplikacji. Należy również określić identyfikator dzierżawy. Jeśli zostanie określona wiadomość e-mail, zostanie ona zignorowana, a użytkownik nie będzie użytkownikiem jednostki usługi, ale standardowym użytkownikiem "e-mail".

--roles

Rozdzielona przecinkami lista ról, które zostaną skojarzone z tym użytkownikiem. Możesz określić jedną z wbudowanych ról lub określić identyfikator roli niestandardowej. Zobacz więcej na stronie https://aka.ms/iotcentral-customrolesdocs. Organizacje można określić obok ról podczas uruchamiania z interfejsem API w wersji == 1.1-preview. Np. "organization_id\role".

--tenant-id --tnid

Identyfikator dzierżawy dla jednostki usługi, która ma zostać dodana do aplikacji. Należy również określić identyfikator obiektu. Jeśli zostanie określona wiadomość e-mail, zostanie ona zignorowana, a użytkownik nie będzie użytkownikiem jednostki usługi, ale standardowym użytkownikiem "e-mail".

--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.