az iot central organization

Nota

Essa referência faz parte da extensão azure-iot para a CLI do Azure (versão 2.46.0 ou superior). A extensão será instalada automaticamente na primeira vez que você executar um comando az iot central organization . Saiba mais sobre extensões.

Gerencie e configure organizações para um aplicativo IoT Central.

Comandos

Name	Description	Tipo	Status
az iot central organization create	Crie uma organização no aplicativo.	Extensão	GA
az iot central organization delete	Excluir uma organização por ID.	Extensão	GA
az iot central organization list	Obtenha a lista de organizações para um aplicativo do IoT Central.	Extensão	GA
az iot central organization show	Obtenha os detalhes de uma organização por ID.	Extensão	GA
az iot central organization update	Atualize uma organização no aplicativo.	Extensão	GA

az iot central organization create

Crie uma organização no aplicativo.

az iot central organization create --app-id
                                   --org-id
                                   [--api-version {2022-07-31}]
                                   [--central-api-uri]
                                   [--org-name]
                                   [--parent-id]
                                   [--token]

Exemplos

Criar uma nova organização

az iot central organization create --app-id {appid} --org-id {organizationId}

Crie uma organização, filho de um pai no aplicativo.

az iot central organization create --app-id {appid} --org-id {organizationId} --parent-id {parentId}

Parâmetros Obrigatórios

--app-id -n

A ID do aplicativo IoT Central que você deseja gerenciar. Você pode encontrar o ID do aplicativo na página "Sobre" do seu aplicativo no menu de ajuda.

--org-id

Identificador exclusivo da organização.

Parâmetros Opcionais

--api-version --av

Preterido

O argumento 'api_version' foi preterido e será removido em uma versão futura.

A versão da API para a operação solicitada.

Valores aceites: 2022-07-31

Default value: 2022-07-31

--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Default value: azureiotcentral.com

--org-name

Nome para exibição da organização.

--parent-id

A ID do pai da organização.

--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você pode especificar um token de usuário válido para autenticar sua solicitação. Você deve especificar o tipo de chave como parte da solicitação. Saiba mais em https://aka.ms/iotcentraldocsapi.

Parâmetros de Globais

--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az iot central organization delete

Excluir uma organização por ID.

az iot central organization delete --app-id
                                   --org-id
                                   [--api-version {2022-07-31}]
                                   [--central-api-uri]
                                   [--token]

Exemplos

Excluir uma organização

az iot central organization delete --app-id {appid} --org-id {organizationId}

Parâmetros Obrigatórios

--app-id -n

A ID do aplicativo IoT Central que você deseja gerenciar. Você pode encontrar o ID do aplicativo na página "Sobre" do seu aplicativo no menu de ajuda.

--org-id

Identificador exclusivo da organização.

Parâmetros Opcionais

--api-version --av

Preterido

O argumento 'api_version' foi preterido e será removido em uma versão futura.

A versão da API para a operação solicitada.

Valores aceites: 2022-07-31

Default value: 2022-07-31

--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Default value: azureiotcentral.com

--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você pode especificar um token de usuário válido para autenticar sua solicitação. Você deve especificar o tipo de chave como parte da solicitação. Saiba mais em https://aka.ms/iotcentraldocsapi.

Parâmetros de Globais

--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az iot central organization list

Obtenha a lista de organizações para um aplicativo do IoT Central.

az iot central organization list --app-id
                                 [--api-version {2022-07-31}]
                                 [--central-api-uri]
                                 [--token]

Exemplos

Listar organizações em um aplicativo

az iot central organization list --app-id {appid}

Parâmetros Obrigatórios

--app-id -n

A ID do aplicativo IoT Central que você deseja gerenciar. Você pode encontrar o ID do aplicativo na página "Sobre" do seu aplicativo no menu de ajuda.

Parâmetros Opcionais

--api-version --av

Preterido

O argumento 'api_version' foi preterido e será removido em uma versão futura.

A versão da API para a operação solicitada.

Valores aceites: 2022-07-31

Default value: 2022-07-31

--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Default value: azureiotcentral.com

--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você pode especificar um token de usuário válido para autenticar sua solicitação. Você deve especificar o tipo de chave como parte da solicitação. Saiba mais em https://aka.ms/iotcentraldocsapi.

Parâmetros de Globais

--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az iot central organization show

Obtenha os detalhes de uma organização por ID.

az iot central organization show --app-id
                                 --org-id
                                 [--api-version {2022-07-31}]
                                 [--central-api-uri]
                                 [--token]

Exemplos

Obter detalhes da organização

az iot central organization show --app-id {appid} --org-id {organizationId}

Parâmetros Obrigatórios

--app-id -n

A ID do aplicativo IoT Central que você deseja gerenciar. Você pode encontrar o ID do aplicativo na página "Sobre" do seu aplicativo no menu de ajuda.

--org-id

Identificador exclusivo da organização.

Parâmetros Opcionais

--api-version --av

Preterido

O argumento 'api_version' foi preterido e será removido em uma versão futura.

A versão da API para a operação solicitada.

Valores aceites: 2022-07-31

Default value: 2022-07-31

--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Default value: azureiotcentral.com

--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você pode especificar um token de usuário válido para autenticar sua solicitação. Você deve especificar o tipo de chave como parte da solicitação. Saiba mais em https://aka.ms/iotcentraldocsapi.

Parâmetros de Globais

--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az iot central organization update

Atualize uma organização no aplicativo.

az iot central organization update --app-id
                                   --org-id
                                   [--api-version {2022-07-31}]
                                   [--central-api-uri]
                                   [--org-name]
                                   [--parent-id]
                                   [--token]

Exemplos

Atualizar pai de uma organização

az iot central organization update --app-id {appid} --org-id {organizationId} --parent-id {parentId}

Atualizar nome de uma organização

az iot central organization update --app-id {appid} --org-id {organizationId} --org-name {organizationName}

Parâmetros Obrigatórios

--app-id -n

A ID do aplicativo IoT Central que você deseja gerenciar. Você pode encontrar o ID do aplicativo na página "Sobre" do seu aplicativo no menu de ajuda.

--org-id

Identificador exclusivo da organização.

Parâmetros Opcionais

--api-version --av

Preterido

O argumento 'api_version' foi preterido e será removido em uma versão futura.

A versão da API para a operação solicitada.

Valores aceites: 2022-07-31

Default value: 2022-07-31

--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Default value: azureiotcentral.com

--org-name

Nome para exibição da organização.

--parent-id

A ID do pai da organização.

--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você pode especificar um token de usuário válido para autenticar sua solicitação. Você deve especificar o tipo de chave como parte da solicitação. Saiba mais em https://aka.ms/iotcentraldocsapi.

Parâmetros de Globais

--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.