az iot central organization

Observação

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.

Gerenciar e configurar organizações para um aplicativo IoT Central.

Comandos

Nome	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 organização

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

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

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

Parâmetros Exigidos

--app-id -n

A ID do aplicativo do 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 aceitos: 2022-07-31

Valor padrão: 2022-07-31

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

O sufixo DNS do IoT Central associado ao seu aplicativo.

Valor padrão: 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ê poderá 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 Globais

--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc

Valor padrão: json

--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. 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 Exigidos

--app-id -n

A ID do aplicativo do 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 aceitos: 2022-07-31

Valor padrão: 2022-07-31

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

O sufixo DNS do IoT Central associado ao seu aplicativo.

Valor padrão: azureiotcentral.com

--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você poderá 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 Globais

--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc

Valor padrão: json

--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. 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 Exigidos

--app-id -n

A ID do aplicativo do 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 aceitos: 2022-07-31

Valor padrão: 2022-07-31

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

O sufixo DNS do IoT Central associado ao seu aplicativo.

Valor padrão: azureiotcentral.com

--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você poderá 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 Globais

--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc

Valor padrão: json

--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. 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 Exigidos

--app-id -n

A ID do aplicativo do 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 aceitos: 2022-07-31

Valor padrão: 2022-07-31

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

O sufixo DNS do IoT Central associado ao seu aplicativo.

Valor padrão: azureiotcentral.com

--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você poderá 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 Globais

--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc

Valor padrão: json

--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. 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 o nome de uma organização

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

Parâmetros Exigidos

--app-id -n

A ID do aplicativo do 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 aceitos: 2022-07-31

Valor padrão: 2022-07-31

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

O sufixo DNS do IoT Central associado ao seu aplicativo.

Valor padrão: 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ê poderá 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 Globais

--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc

Valor padrão: json

--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.