Udostępnij przez

az iot central api-token

Note

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

Zarządzanie tokenami interfejsu API dla aplikacji usługi IoT Central.

Usługa IoT Central umożliwia generowanie tokenów interfejsu API i zarządzanie nimi w celu uzyskania dostępu do interfejsu API usługi IoT Central. Więcej informacji na temat interfejsów API można znaleźć na stronie https://aka.ms/iotcentraldocsapi.

Polecenia

Nazwa Opis Typ Stan
az iot central api-token create

Wygeneruj token interfejsu API skojarzony z aplikacją usługi IoT Central.

 Extension ogólna dostępność
az iot central api-token delete

Usuń token interfejsu API skojarzony z aplikacją usługi IoT Central.

 Extension ogólna dostępność
az iot central api-token list

Pobierz listę tokenów interfejsu API skojarzonych z aplikacją usługi IoT Central.

 Extension ogólna dostępność
az iot central api-token show

Uzyskaj szczegółowe informacje dotyczące tokenu interfejsu API skojarzonego z aplikacją usługi IoT Central.

 Extension ogólna dostępność

az iot central api-token create

Wygeneruj token interfejsu API skojarzony z aplikacją usługi IoT Central.

Uwaga: zapisz token po jego wygenerowaniu, ponieważ nie będzie można go pobrać ponownie.

az iot central api-token create --app-id
                                --role
                                --tkid --token-id
                                [--api-version --av {2022-06-30-preview, 2022-07-31}]
                                [--central-api-uri --central-dns-suffix]
                                [--org-id --organization-id]
                                [--token]

Przykłady

Dodawanie nowego tokenu interfejsu API

az iot central api-token create --token-id {tokenId} --app-id {appId} --role 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.

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

--tkid --token-id

Identyfikator usługi IoT Central skojarzony z tym tokenem [0-9a-zA-Z-] dozwolony maksymalny limit długości do 40. Określ identyfikator, który będzie następnie używany podczas modyfikowania lub usuwania tego tokenu później za pośrednictwem interfejsu wiersza polecenia lub interfejsu API.

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

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

Właściwość Wartość
Domyślna wartość: 2022-07-31
Dopuszczalne wartości: 2022-06-30-preview, 2022-07-31
--central-api-uri --central-dns-suffix

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

Właściwość Wartość
Domyślna wartość: azureiotcentral.com
--org-id --organization-id

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

--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 stronie https://aka.ms/iotcentraldocsapi.

Parametry globalne
--debug

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

Właściwość Wartość
Domyślna wartość: False
--help -h

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

--only-show-errors

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

Właściwość Wartość
Domyślna wartość: False
--output -o

Format danych wyjściowych.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--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 az account set -s NAME_OR_ID.

--verbose

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

Właściwość Wartość
Domyślna wartość: False

az iot central api-token delete

Usuń token interfejsu API skojarzony z aplikacją usługi IoT Central.

az iot central api-token delete --app-id
                                --tkid --token-id
                                [--api-version --av {2022-06-30-preview, 2022-07-31}]
                                [--central-api-uri --central-dns-suffix]
                                [--token]

Przykłady

Usuwanie tokenu interfejsu API

az iot central api-token delete --app-id {appid} --token-id {tokenId}

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.

--tkid --token-id

Identyfikator usługi IoT Central skojarzony z tym tokenem [0-9a-zA-Z-] dozwolony maksymalny limit długości do 40. Określ identyfikator, który będzie następnie używany podczas modyfikowania lub usuwania tego tokenu później za pośrednictwem interfejsu wiersza polecenia lub interfejsu API.

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

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

Właściwość Wartość
Domyślna wartość: 2022-07-31
Dopuszczalne wartości: 2022-06-30-preview, 2022-07-31
--central-api-uri --central-dns-suffix

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

Właściwość Wartość
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 stronie https://aka.ms/iotcentraldocsapi.

Parametry globalne
--debug

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

Właściwość Wartość
Domyślna wartość: False
--help -h

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

--only-show-errors

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

Właściwość Wartość
Domyślna wartość: False
--output -o

Format danych wyjściowych.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--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 az account set -s NAME_OR_ID.

--verbose

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

Właściwość Wartość
Domyślna wartość: False

az iot central api-token list

Pobierz listę tokenów interfejsu API skojarzonych z aplikacją usługi IoT Central.

Informacje na liście zawierają podstawowe informacje o tokenach w aplikacji i nie zawierają wartości tokenów.

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

Przykłady

Lista tokenów interfejsu API

az iot central api-token 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

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

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

Właściwość Wartość
Domyślna wartość: 2022-07-31
Dopuszczalne wartości: 2022-06-30-preview, 2022-07-31
--central-api-uri --central-dns-suffix

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

Właściwość Wartość
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 stronie https://aka.ms/iotcentraldocsapi.

Parametry globalne
--debug

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

Właściwość Wartość
Domyślna wartość: False
--help -h

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

--only-show-errors

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

Właściwość Wartość
Domyślna wartość: False
--output -o

Format danych wyjściowych.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--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 az account set -s NAME_OR_ID.

--verbose

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

Właściwość Wartość
Domyślna wartość: False

az iot central api-token show

Uzyskaj szczegółowe informacje dotyczące tokenu interfejsu API skojarzonego z aplikacją usługi IoT Central.

Wyświetl szczegóły, takie jak skojarzona rola, dla tokenu interfejsu API w aplikacji usługi IoT Central.

az iot central api-token show --app-id
                              --tkid --token-id
                              [--api-version --av {2022-06-30-preview, 2022-07-31}]
                              [--central-api-uri --central-dns-suffix]
                              [--token]

Przykłady

Uzyskiwanie tokenu interfejsu API

az iot central api-token show --app-id {appid} --token-id {tokenId}

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.

--tkid --token-id

Identyfikator usługi IoT Central skojarzony z tym tokenem [0-9a-zA-Z-] dozwolony maksymalny limit długości do 40. Określ identyfikator, który będzie następnie używany podczas modyfikowania lub usuwania tego tokenu później za pośrednictwem interfejsu wiersza polecenia lub interfejsu API.

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

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

Właściwość Wartość
Domyślna wartość: 2022-07-31
Dopuszczalne wartości: 2022-06-30-preview, 2022-07-31
--central-api-uri --central-dns-suffix

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

Właściwość Wartość
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 stronie https://aka.ms/iotcentraldocsapi.

Parametry globalne
--debug

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

Właściwość Wartość
Domyślna wartość: False
--help -h

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

--only-show-errors

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

Właściwość Wartość
Domyślna wartość: False
--output -o

Format danych wyjściowych.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--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 az account set -s NAME_OR_ID.

--verbose

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

Właściwość Wartość
Domyślna wartość: False