az iot central user

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 user-kommando . Läs mer om tillägg.

Hantera och konfigurera IoT Central-användare.

Kommandon

Name	Description	Typ	Status
az iot central user create	Lägg till en användare i programmet.	Anknytning	Allmän tillgänglighet
az iot central user delete	Ta bort en användare från programmet.	Anknytning	Allmän tillgänglighet
az iot central user list	Hämta en lista över användare för ett IoT Central-program.	Anknytning	Allmän tillgänglighet
az iot central user show	Hämta information om en användare efter ID.	Anknytning	Allmän tillgänglighet
az iot central user update	Uppdatera roller för en användare i programmet.	Anknytning	Allmän tillgänglighet

az iot central user create

Lägg till en användare i programmet.

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]

Exempel

Lägga till en användare via e-post i programmet

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

Lägga till ett huvudnamn för tjänsten i programmet

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

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.

--assignee --user-id

ID som är associerat med användaren.

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

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

--email

E-postadress till användaren som ska läggas till i appen. Om detta anges ignoreras parametrarna för tjänstens huvudnamn (tenant_id och object_id).

--object-id --oid

Objekt-ID för tjänstens huvudnamn som ska läggas till i appen. Klientorganisations-ID måste också anges. Om e-post anges ignoreras detta och användaren är inte en användare av tjänstens huvudnamn utan en standardanvändare för "e-post".

--org-id --organization-id

ID:t för organisationen för tilldelningen av användarrollen. Endast tillgängligt för api-version == 1.1-preview.

--tenant-id --tnid

Klientorganisations-ID för tjänstens huvudnamn som ska läggas till i appen. Objekt-ID måste också anges. Om e-post anges ignoreras detta och användaren är inte en användare av tjänstens huvudnamn utan en standardanvändare för "e-post".

--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 user delete

Ta bort en användare från programmet.

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

Exempel

Ta bort en användare

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

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.

--assignee --user-id

ID som är associerat med användaren.

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 user list

Hämta en lista över användare för ett IoT Central-program.

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

Exempel

Lista över användare

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

Hämta information om en användare efter ID.

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

Exempel

Hämta information om användaren

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

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.

--assignee --user-id

ID som är associerat med användaren.

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 user update

Uppdatera roller för en användare i programmet.

Uppdatera en användare med en annan roll. Det är inte tillåtet att uppdatera tenantId eller objectId för en användare av tjänstens huvudnamn. Det är inte tillåtet att uppdatera e-postadressen för en e-postanvändare.

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]

Exempel

Uppdatera roller för en användare via e-post eller tjänstens huvudnamn i programmet.

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

--assignee --user-id

ID som är associerat med användaren.

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

--email

E-postadress till användaren som ska läggas till i appen. Om detta anges ignoreras parametrarna för tjänstens huvudnamn (tenant_id och object_id).

--object-id --oid

Objekt-ID för tjänstens huvudnamn som ska läggas till i appen. Klientorganisations-ID måste också anges. Om e-post anges ignoreras detta och användaren är inte en användare av tjänstens huvudnamn utan en standardanvändare för "e-post".

--roles

Kommaavgränsad lista över roller som ska associeras med den här 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. Organisationer kan anges tillsammans med roller när de körs med API-version == 1.1-förhandsversion. T.ex. "organization_id\role".

--tenant-id --tnid

Klientorganisations-ID för tjänstens huvudnamn som ska läggas till i appen. Objekt-ID måste också anges. Om e-post anges ignoreras detta och användaren är inte en användare av tjänstens huvudnamn utan en standardanvändare för "e-post".

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