Dela via

az iot central api-token

  • Referens

Kommentar

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

Hantera API-token för ditt IoT Central-program.

Med IoT Central kan du generera och hantera API-token som ska användas för att komma åt IoT Central-API:et. Mer information om API:er finns på https://aka.ms/iotcentraldocsapi.

Kommandon

Name Description Typ Status
az iot central api-token create

Generera en API-token som är associerad med ditt IoT Central-program.

 Anknytning Allmän tillgänglighet
az iot central api-token delete

Ta bort en API-token som är associerad med ditt IoT Central-program.

 Anknytning Allmän tillgänglighet
az iot central api-token list

Hämta listan över API-token som är associerade med ditt IoT Central-program.

 Anknytning Allmän tillgänglighet
az iot central api-token show

Få information om en API-token som är associerad med ditt IoT Central-program.

 Anknytning Allmän tillgänglighet

az iot central api-token create

Generera en API-token som är associerad med ditt IoT Central-program.

Obs! Skriv ned din token när den har genererats eftersom du inte kan hämta den igen.

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

Exempel

Lägga till ny API-token

az iot central api-token create --token-id {tokenId} --app-id {appId} --role admin

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.

--role -r

Den roll som ska associeras med den här token eller användaren. Du kan ange en av de inbyggda rollerna eller ange roll-ID för en anpassad roll. Se mer på https://aka.ms/iotcentral-customrolesdocs.

--tkid --token-id

Det IoT Central-ID som är associerat med denna token, [0-9a-zA-Z-] tillåtet, max längdgräns till 40. Ange ett ID som du sedan ska använda när du ändrar eller tar bort den här token senare via CLI eller API:et.

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.

Godkända 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
--org-id --organization-id

ID för organisationen för tokenrolltilldelningen. Endast tillgängligt för api-version == 1.1-preview.

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

Godkända 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 api-token delete

Ta bort en API-token som är associerad med ditt IoT Central-program.

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

Exempel

Ta bort en API-token

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

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.

--tkid --token-id

Det IoT Central-ID som är associerat med denna token, [0-9a-zA-Z-] tillåtet, max längdgräns till 40. Ange ett ID som du sedan ska använda när du ändrar eller tar bort den här token senare via CLI eller API:et.

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.

Godkända 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.

Godkända 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 api-token list

Hämta listan över API-token som är associerade med ditt IoT Central-program.

Informationen i listan innehåller grundläggande information om token i programmet och innehåller inte tokenvärden.

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

Exempel

Lista över API-token

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

Godkända 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.

Godkända 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 api-token show

Få information om en API-token som är associerad med ditt IoT Central-program.

Visa information, till exempel dess associerade roll, för en API-token i din IoT Central-app.

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

Exempel

Hämta API-token

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

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.

--tkid --token-id

Det IoT Central-ID som är associerat med denna token, [0-9a-zA-Z-] tillåtet, max längdgräns till 40. Ange ett ID som du sedan ska använda när du ändrar eller tar bort den här token senare via CLI eller API:et.

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.

Godkända 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.

Godkända 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.