Delen via

az iot central api-token

Note

Deze verwijzing maakt deel uit van de Azure-iot-extensie voor de Azure CLI (versie 2.67.0 of hoger). De extensie installeert automatisch de eerste keer dat u een opdracht az iot central api-token uitvoert. Meer informatie over uitbreidingen.

API-tokens voor uw IoT Central-toepassing beheren.

Met IoT Central kunt u API-tokens genereren en beheren die moeten worden gebruikt voor toegang tot de IoT Central-API. Meer informatie over API's vindt u op https://aka.ms/iotcentraldocsapi.

Opdracht

Name Description Type Status
az iot central api-token create

Genereer een API-token dat is gekoppeld aan uw IoT Central-toepassing.

 Extension GA
az iot central api-token delete

Verwijder een API-token dat is gekoppeld aan uw IoT Central-toepassing.

 Extension GA
az iot central api-token list

Haal de lijst met API-tokens op die zijn gekoppeld aan uw IoT Central-toepassing.

 Extension GA
az iot central api-token show

Details ophalen voor een API-token dat is gekoppeld aan uw IoT Central-toepassing.

 Extension GA

az iot central api-token create

Genereer een API-token dat is gekoppeld aan uw IoT Central-toepassing.

Opmerking: Noteer het token zodra het is gegenereerd, omdat u het niet meer kunt ophalen.

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]

Voorbeelden

Nieuw API-token toevoegen

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

Vereiste parameters

--app-id -n

De app-id van de IoT Central-app die u wilt beheren. U vindt de app-id op de pagina Info voor uw toepassing onder het menu Help.

--role -r

De rol die wordt gekoppeld aan dit token of deze gebruiker. U kunt een van de ingebouwde rollen opgeven of de rol-id van een aangepaste rol opgeven. Zie meer op https://aka.ms/iotcentral-customrolesdocs.

--tkid --token-id

De IoT Central-id die aan dit token is gekoppeld, [0-9a-zA-Z-] is toegestaan, maximale lengtelimiet tot 40. Geef een id op die u vervolgens gebruikt wanneer u dit token later wijzigt of verwijdert via de CLI of API.

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--api-version --av
Afgeschaft

Het argument 'api_version' is afgeschaft en wordt in een toekomstige release verwijderd.

Deze opdrachtparameter is afgeschaft en wordt genegeerd. In de toekomstige release ondersteunen we alleen IoT Central-API's van de nieuwste GA-versie. Als er nog geen API beschikbaar is, roepen we de nieuwste preview-versie aan.

Eigenschap Waarde
Default value: 2022-07-31
Geaccepteerde waarden: 2022-06-30-preview, 2022-07-31
--central-api-uri --central-dns-suffix

Het DNS-achtervoegsel ioT Central dat is gekoppeld aan uw toepassing.

Eigenschap Waarde
Default value: azureiotcentral.com
--org-id --organization-id

De id van de organisatie voor de roltoewijzing van het token. Alleen beschikbaar voor api-version == 1.1-preview.

--token

Als u liever uw aanvraag indient zonder verificatie bij de Azure CLI, kunt u een geldig gebruikerstoken opgeven om uw aanvraag te verifiëren. U moet het type sleutel opgeven als onderdeel van de aanvraag. Meer informatie vindt u op https://aka.ms/iotcentraldocsapi.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap Waarde
Default value: False

az iot central api-token delete

Verwijder een API-token dat is gekoppeld aan uw IoT Central-toepassing.

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]

Voorbeelden

Een API-token verwijderen

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

Vereiste parameters

--app-id -n

De app-id van de IoT Central-app die u wilt beheren. U vindt de app-id op de pagina Info voor uw toepassing onder het menu Help.

--tkid --token-id

De IoT Central-id die aan dit token is gekoppeld, [0-9a-zA-Z-] is toegestaan, maximale lengtelimiet tot 40. Geef een id op die u vervolgens gebruikt wanneer u dit token later wijzigt of verwijdert via de CLI of API.

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--api-version --av
Afgeschaft

Het argument 'api_version' is afgeschaft en wordt in een toekomstige release verwijderd.

Deze opdrachtparameter is afgeschaft en wordt genegeerd. In de toekomstige release ondersteunen we alleen IoT Central-API's van de nieuwste GA-versie. Als er nog geen API beschikbaar is, roepen we de nieuwste preview-versie aan.

Eigenschap Waarde
Default value: 2022-07-31
Geaccepteerde waarden: 2022-06-30-preview, 2022-07-31
--central-api-uri --central-dns-suffix

Het DNS-achtervoegsel ioT Central dat is gekoppeld aan uw toepassing.

Eigenschap Waarde
Default value: azureiotcentral.com
--token

Als u liever uw aanvraag indient zonder verificatie bij de Azure CLI, kunt u een geldig gebruikerstoken opgeven om uw aanvraag te verifiëren. U moet het type sleutel opgeven als onderdeel van de aanvraag. Meer informatie vindt u op https://aka.ms/iotcentraldocsapi.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap Waarde
Default value: False

az iot central api-token list

Haal de lijst met API-tokens op die zijn gekoppeld aan uw IoT Central-toepassing.

Informatie in de lijst bevat basisinformatie over de tokens in de toepassing en bevat geen tokenwaarden.

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]

Voorbeelden

Lijst met API-tokens

az iot central api-token list --app-id {appid}

Vereiste parameters

--app-id -n

De app-id van de IoT Central-app die u wilt beheren. U vindt de app-id op de pagina Info voor uw toepassing onder het menu Help.

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--api-version --av
Afgeschaft

Het argument 'api_version' is afgeschaft en wordt in een toekomstige release verwijderd.

Deze opdrachtparameter is afgeschaft en wordt genegeerd. In de toekomstige release ondersteunen we alleen IoT Central-API's van de nieuwste GA-versie. Als er nog geen API beschikbaar is, roepen we de nieuwste preview-versie aan.

Eigenschap Waarde
Default value: 2022-07-31
Geaccepteerde waarden: 2022-06-30-preview, 2022-07-31
--central-api-uri --central-dns-suffix

Het DNS-achtervoegsel ioT Central dat is gekoppeld aan uw toepassing.

Eigenschap Waarde
Default value: azureiotcentral.com
--token

Als u liever uw aanvraag indient zonder verificatie bij de Azure CLI, kunt u een geldig gebruikerstoken opgeven om uw aanvraag te verifiëren. U moet het type sleutel opgeven als onderdeel van de aanvraag. Meer informatie vindt u op https://aka.ms/iotcentraldocsapi.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap Waarde
Default value: False

az iot central api-token show

Details ophalen voor een API-token dat is gekoppeld aan uw IoT Central-toepassing.

Geef details weer, zoals de bijbehorende rol, voor een API-token in uw IoT Central-app.

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]

Voorbeelden

API-token ophalen

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

Vereiste parameters

--app-id -n

De app-id van de IoT Central-app die u wilt beheren. U vindt de app-id op de pagina Info voor uw toepassing onder het menu Help.

--tkid --token-id

De IoT Central-id die aan dit token is gekoppeld, [0-9a-zA-Z-] is toegestaan, maximale lengtelimiet tot 40. Geef een id op die u vervolgens gebruikt wanneer u dit token later wijzigt of verwijdert via de CLI of API.

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--api-version --av
Afgeschaft

Het argument 'api_version' is afgeschaft en wordt in een toekomstige release verwijderd.

Deze opdrachtparameter is afgeschaft en wordt genegeerd. In de toekomstige release ondersteunen we alleen IoT Central-API's van de nieuwste GA-versie. Als er nog geen API beschikbaar is, roepen we de nieuwste preview-versie aan.

Eigenschap Waarde
Default value: 2022-07-31
Geaccepteerde waarden: 2022-06-30-preview, 2022-07-31
--central-api-uri --central-dns-suffix

Het DNS-achtervoegsel ioT Central dat is gekoppeld aan uw toepassing.

Eigenschap Waarde
Default value: azureiotcentral.com
--token

Als u liever uw aanvraag indient zonder verificatie bij de Azure CLI, kunt u een geldig gebruikerstoken opgeven om uw aanvraag te verifiëren. U moet het type sleutel opgeven als onderdeel van de aanvraag. Meer informatie vindt u op https://aka.ms/iotcentraldocsapi.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap Waarde
Default value: False