Partilhar via


az iot ops broker authz

Note

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

Gerenciamento de autorização do corretor Mqtt.

Comandos

Name Description Tipo Status
az iot ops broker authz apply

Crie ou substitua um recurso de autorização do agente mqtt.

Extension disponibilidade geral
az iot ops broker authz delete

Exclua um recurso de autorização do broker mqtt.

Extension disponibilidade geral
az iot ops broker authz list

Liste os recursos de autorização do broker mqtt associados a um broker.

Extension disponibilidade geral
az iot ops broker authz show

Mostrar detalhes de um recurso de autorização do corretor mqtt.

Extension disponibilidade geral

az iot ops broker authz apply

Crie ou substitua um recurso de autorização do agente mqtt.

Um exemplo do formato de arquivo de configuração é o seguinte:

{
    "authorizationPolicies": {
        "cache": "Enabled",
        "rules": [
            {
                "principals": {
                    "clientIds": [
                        "temperature-sensor",
                        "humidity-sensor"
                    ],
                    "attributes": [
                        {
                            "city": "seattle",
                            "organization": "contoso"
                        }
                    ]
                },
                "brokerResources": [
                    {
                        "method": "Connect"
                    },
                    {
                        "method": "Publish",
                        "topics": [
                            "/telemetry/{principal.clientId}",
                            "/telemetry/{principal.attributes.organization}"
                        ]
                    },
                    {
                        "method": "Subscribe",
                        "topics": [
                            "/commands/{principal.attributes.organization}"
                        ]
                    }
                ]
            }
        ]
    }
}

Quando usado com a aplicação, o conteúdo acima criará ou substituirá um recurso de autorização de destino configurado com uma única regra authz.

az iot ops broker authz apply --config-file
                              --instance
                              --name
                              --resource-group
                              [--broker]

Exemplos

Crie ou substitua um recurso de autorização para o broker padrão usando um arquivo de configuração.

az iot ops broker authz apply -n authz --in myinstance -g myresourcegroup --config-file /path/to/authz/config.json

Parâmetros Obrigatórios

--config-file

Caminho para um arquivo de configuração contendo propriedades de recurso no formato json. O arquivo de configuração deve conter um objeto com propriedades compatíveis com a representação ARM do recurso. O objeto se correlaciona diretamente com 'propriedades:{}' do recurso ARM.

Propriedade Valor
Grupo de parâmetros: Config Arguments
--instance -i

Nome da instância de Operações IoT.

--name -n

Nome do recurso de autorização do broker Mqtt.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--broker -b

Nome do corretor Mqtt.

Propriedade Valor
Default value: default
Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Propriedade Valor
Default value: False

az iot ops broker authz delete

Exclua um recurso de autorização do broker mqtt.

az iot ops broker authz delete --instance
                               --name
                               --resource-group
                               [--broker]
                               [--yes {false, true}]

Exemplos

Exclua o recurso de autorização do broker mqtt chamado 'authz' associado ao broker padrão.

az iot ops broker authz delete -n authz --in myinstance -g myresourcegroup

O mesmo que o exemplo anterior, mas ignorando o prompt de confirmação.

az iot ops broker authz delete -n authz --in myinstance -g myresourcegroup -y

Parâmetros Obrigatórios

--instance -i

Nome da instância de Operações IoT.

--name -n

Nome do recurso de autorização do broker Mqtt.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--broker -b

Nome do corretor Mqtt.

Propriedade Valor
Default value: default
--yes -y

Confirme [s]es sem um prompt. Útil para cenários de CI e automação.

Propriedade Valor
Valores aceites: false, true
Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Propriedade Valor
Default value: False

az iot ops broker authz list

Liste os recursos de autorização do broker mqtt associados a um broker.

az iot ops broker authz list --instance
                             --resource-group
                             [--broker]

Exemplos

Enumere todos os recursos de autorização do broker mqtt associados ao broker padrão.

az iot ops broker authz list --in myinstance -g myresourcegroup

Parâmetros Obrigatórios

--instance -i

Nome da instância de Operações IoT.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--broker -b

Nome do corretor Mqtt.

Propriedade Valor
Default value: default
Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Propriedade Valor
Default value: False

az iot ops broker authz show

Mostrar detalhes de um recurso de autorização do corretor mqtt.

az iot ops broker authz show --instance
                             --name
                             --resource-group
                             [--broker]

Exemplos

Mostrar detalhes do recurso de autorização padrão associado ao broker padrão.

az iot ops broker authz show -n authz --in myinstance -g myresourcegroup

Parâmetros Obrigatórios

--instance -i

Nome da instância de Operações IoT.

--name -n

Nome do recurso de autorização do broker Mqtt.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--broker -b

Nome do corretor Mqtt.

Propriedade Valor
Default value: default
Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Propriedade Valor
Default value: False