az iot central user

Notitie

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

IoT Central-gebruikers beheren en configureren.

Opdracht

Name Description Type Status
az iot central user create

Voeg een gebruiker toe aan de toepassing.

Toestel GA
az iot central user delete

Een gebruiker uit de toepassing verwijderen.

Toestel GA
az iot central user list

Lijst met gebruikers ophalen voor een IoT Central-toepassing.

Toestel GA
az iot central user show

Haal de details van een gebruiker op id op.

Toestel GA
az iot central user update

Rollen bijwerken voor een gebruiker in de toepassing.

Toestel GA

az iot central user create

Voeg een gebruiker toe aan de toepassing.

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]

Voorbeelden

Een gebruiker per e-mail toevoegen aan de toepassing

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

Een service-principal toevoegen aan de toepassing

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

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.

--assignee --user-id

Id die is gekoppeld aan de gebruiker.

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

Optionele parameters

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

geaccepteerde waarden: 2022-06-30-preview, 2022-07-31
standaardwaarde: 2022-07-31
--central-api-uri --central-dns-suffix

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

standaardwaarde: azureiotcentral.com
--email

E-mailadres van de gebruiker die moet worden toegevoegd aan de app. Als dit is opgegeven, worden parameters voor de service-principal (tenant_id en object_id) genegeerd.

--object-id --oid

Object-id voor service-principal die moet worden toegevoegd aan de app. Tenant-id moet ook worden opgegeven. Als e-mail is opgegeven, wordt dit genegeerd en is de gebruiker geen service-principalgebruiker, maar een standaard -e-mailgebruiker.

--org-id --organization-id

De id van de organisatie voor de toewijzing van de gebruikersrol. Alleen beschikbaar voor api-version == 1.1-preview.

--tenant-id --tnid

Tenant-id voor service-principal die moet worden toegevoegd aan de app. Object-id moet ook worden opgegeven. Als e-mail is opgegeven, wordt dit genegeerd en is de gebruiker geen service-principalgebruiker, maar een standaard -e-mailgebruiker.

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

Globale parameters
--debug

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

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

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

--subscription

Naam of id van het 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.

az iot central user delete

Een gebruiker uit de toepassing verwijderen.

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

Voorbeelden

Een gebruiker verwijderen

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

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.

--assignee --user-id

Id die is gekoppeld aan de gebruiker.

Optionele parameters

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

geaccepteerde waarden: 2022-06-30-preview, 2022-07-31
standaardwaarde: 2022-07-31
--central-api-uri --central-dns-suffix

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

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

Globale parameters
--debug

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

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

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

--subscription

Naam of id van het 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.

az iot central user list

Lijst met gebruikers ophalen voor een IoT Central-toepassing.

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

Voorbeelden

Lijst met gebruikers

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

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

geaccepteerde waarden: 2022-06-30-preview, 2022-07-31
standaardwaarde: 2022-07-31
--central-api-uri --central-dns-suffix

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

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

Globale parameters
--debug

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

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

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

--subscription

Naam of id van het 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.

az iot central user show

Haal de details van een gebruiker op id op.

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

Voorbeelden

Details van gebruiker ophalen

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

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.

--assignee --user-id

Id die is gekoppeld aan de gebruiker.

Optionele parameters

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

geaccepteerde waarden: 2022-06-30-preview, 2022-07-31
standaardwaarde: 2022-07-31
--central-api-uri --central-dns-suffix

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

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

Globale parameters
--debug

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

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

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

--subscription

Naam of id van het 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.

az iot central user update

Rollen bijwerken voor een gebruiker in de toepassing.

Een gebruiker bijwerken met een andere rol. Het bijwerken van de tenantId of objectId voor een service-principalgebruiker is niet toegestaan. Het bijwerken van het e-mailadres voor een e-mailgebruiker is niet toegestaan.

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]

Voorbeelden

Werk rollen voor een gebruiker bij via e-mail of service-principal in de toepassing.

az iot central user update --user-id {userId} --app-id {appId} --roles "org1\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.

--assignee --user-id

Id die is gekoppeld aan de gebruiker.

Optionele parameters

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

geaccepteerde waarden: 2022-06-30-preview, 2022-07-31
standaardwaarde: 2022-07-31
--central-api-uri --central-dns-suffix

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

standaardwaarde: azureiotcentral.com
--email

E-mailadres van de gebruiker die moet worden toegevoegd aan de app. Als dit is opgegeven, worden parameters voor de service-principal (tenant_id en object_id) genegeerd.

--object-id --oid

Object-id voor service-principal die moet worden toegevoegd aan de app. Tenant-id moet ook worden opgegeven. Als e-mail is opgegeven, wordt dit genegeerd en is de gebruiker geen service-principalgebruiker, maar een standaard -e-mailgebruiker.

--roles

Door komma's gescheiden lijst met rollen die aan deze gebruiker worden gekoppeld. 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. Organisaties kunnen naast rollen worden opgegeven bij uitvoering met API-versie == 1.1-preview. Bijvoorbeeld 'organization_id\role'.

--tenant-id --tnid

Tenant-id voor service-principal die moet worden toegevoegd aan de app. Object-id moet ook worden opgegeven. Als e-mail is opgegeven, wordt dit genegeerd en is de gebruiker geen service-principalgebruiker, maar een standaard -e-mailgebruiker.

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

Globale parameters
--debug

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

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

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

--subscription

Naam of id van het 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.