az iot central api-token

Notitie

Deze referentie maakt deel uit van de azure-iot-extensie voor Azure CLI en vereist versie 2.17.1 of hoger. De extensie wordt automatisch geïnstalleerd wanneer u de opdracht az iot central api-token voor het eerst gebruikt. Meer informatie over extensies.

BEHEER API-tokens voor uw IoT Central toepassing.

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

Opdracht

az iot central api-token create

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

az iot central api-token delete

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

az iot central api-token list

Vermeld alle API-tokens die zijn gekoppeld aan IoT Central toepassing.

az iot central api-token show

Haal details op voor een API-token dat is gekoppeld aan IoT Central toepassing.

az iot central api-token create

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

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

az iot central api-token create --app-id
                                --role {admin, builder, operator}
                                --tkid
                                [--api-version {1.0, preview}]
                                [--central-api-uri]
                                [--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 IoT Central app die u wilt beheren. U vindt de app-id op de pagina Over voor uw toepassing onder het Help-menu.

--role -r

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

geaccepteerde waarden: admin, builder, operator
--tkid --token-id

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

Optionele parameters

--api-version --av

De API-versie voor de aangevraagde bewerking.

geaccepteerde waarden: 1.0, preview
standaardwaarde: 1.0
--central-api-uri --central-dns-suffix

Het IoT Central DNS-achtervoegsel dat is gekoppeld aan uw toepassing. De standaardwaarde is: azureiotcentral.com.

standaardwaarde: azureiotcentral.com
--token

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

az iot central api-token delete

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

az iot central api-token delete --app-id
                                --tkid
                                [--api-version {1.0, preview}]
                                [--central-api-uri]
                                [--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 IoT Central app die u wilt beheren. U vindt de app-id op de pagina Over voor uw toepassing onder het Help-menu.

--tkid --token-id

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

Optionele parameters

--api-version --av

De API-versie voor de aangevraagde bewerking.

geaccepteerde waarden: 1.0, preview
standaardwaarde: 1.0
--central-api-uri --central-dns-suffix

Het IoT Central DNS-achtervoegsel dat is gekoppeld aan uw toepassing. De standaardwaarde is: azureiotcentral.com.

standaardwaarde: azureiotcentral.com
--token

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

az iot central api-token list

Vermeld alle API-tokens die zijn gekoppeld aan IoT Central toepassing.

De 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 {1.0, preview}]
                              [--central-api-uri]
                              [--token]

Voorbeelden

Lijst met API-tokens

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

Vereiste parameters

--app-id -n

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

Optionele parameters

--api-version --av

De API-versie voor de aangevraagde bewerking.

geaccepteerde waarden: 1.0, preview
standaardwaarde: 1.0
--central-api-uri --central-dns-suffix

Het IoT Central DNS-achtervoegsel dat is gekoppeld aan uw toepassing. De standaardwaarde is: azureiotcentral.com.

standaardwaarde: azureiotcentral.com
--token

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

az iot central api-token show

Haal details op voor een API-token dat is gekoppeld aan IoT Central toepassing.

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

az iot central api-token show --app-id
                              --tkid
                              [--api-version {1.0, preview}]
                              [--central-api-uri]
                              [--token]

Voorbeelden

API-token op halen

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

Vereiste parameters

--app-id -n

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

--tkid --token-id

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

Optionele parameters

--api-version --av

De API-versie voor de aangevraagde bewerking.

geaccepteerde waarden: 1.0, preview
standaardwaarde: 1.0
--central-api-uri --central-dns-suffix

Het IoT Central DNS-achtervoegsel dat is gekoppeld aan uw toepassing. De standaardwaarde is: azureiotcentral.com.

standaardwaarde: azureiotcentral.com
--token

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