Partilhar via

az iot hub state

  • Experimental

Note

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

Este grupo de comando é experimental e está em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Gere o estado de um Hub IoT.

Para obter mais informações, consulte aka.ms/aziotcli-iot-hub-state.

Comandos

Name Description Tipo Status
az iot hub state export

Exporte o estado de um Hub IoT para um ficheiro.

 Extension Experimental
az iot hub state import

Importa um estado de Hub de um ficheiro para um Hub IoT.

 Extension Experimental
az iot hub state migrate

Migre o estado de um hub para outro sem salvar em um arquivo.

 Extension Experimental

az iot hub state export

Experimental

O grupo de comando 'iot hub state' é experimental e está em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Exporte o estado de um Hub IoT para um ficheiro.

Por padrão, o estado exportado incluirá: modelo arm para hub, configurações de hub (incluindo configurações ADM e implantações de borda), informações do dispositivo (incluindo identificações de dispositivos, gêmeos de dispositivos, identidades de módulos e gêmeos de módulos).

Para obter mais informações, consulte aka.ms/aziotcli-iot-hub-state.

az iot hub state export --state-file
                        [--acquire-policy-token]
                        [--aspects {arm, configurations, devices}]
                        [--auth-type {key, login}]
                        [--change-reference]
                        [--hub-name]
                        [--login]
                        [--replace]
                        [--resource-group]

Exemplos

Exporte o estado suportado do hub especificado para o arquivo especificado.

az iot hub state export -n {iothub_name} -f {state_filename}

Exporte o estado suportado do hub especificado para o arquivo especificado, substituindo o conteúdo do arquivo.

az iot hub state export -n {iothub_name} -f {state_filename} -r

Exporte apenas os dispositivos e as configurações do hub especificado para o arquivo especificado.

az iot hub state export -n {iothub_name} -f {state_filename} --aspects devices configurations

Parâmetros Obrigatórios

--state-file -f

O caminho para o arquivo onde as informações de estado serão armazenadas.

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.

--acquire-policy-token

Aquisição automática de um token Azure Policy para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--aspects

Aspetos do Hub (separados por espaço).

Propriedade Valor
Valores aceites: arm, configurations, devices
--auth-type

Indica se a operação deve derivar automaticamente uma chave de política ou usar a sessão atual do Azure AD. Se o tipo de autenticação for login e o nome de host do recurso for fornecido, a pesquisa de recursos será ignorada, a menos que necessário. Você pode configurar o padrão usando az configure --defaults iothub-data-auth-type={auth-type-value}.

Propriedade Valor
Grupo de parâmetros: Access Control Arguments
Default value: key
Valores aceites: key, login
--change-reference

O ID de referência de alteração relacionado para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--hub-name -n

Nome do Hub IoT ou nome de host. Obrigatório se --login não for fornecido.

Propriedade Valor
Grupo de parâmetros: IoT Hub Identifier Arguments
--login -l

Este comando suporta uma cadeia de ligação de entidade com direitos para executar ações. Use para evitar login de sessão via "az login". Se forem fornecidos tanto uma entidade, cadeia de ligação como o nome, a cadeia de ligação tem prioridade. Obrigatório se --hub-name não for fornecido.

Propriedade Valor
Grupo de parâmetros: IoT Hub Identifier Arguments
--replace -r

Se esse sinalizador estiver definido, o comando substituirá o conteúdo do arquivo de saída.

Propriedade Valor
Default value: False
--resource-group -g

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

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 hub state import

Experimental

O grupo de comando 'iot hub state' é experimental e está em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Importa um estado de Hub de um ficheiro para um Hub IoT.

Se o aspeto arm for especificado, o hub será criado se não existir.

Por padrão, o estado importado incluirá: modelo arm para hub, configurações de hub (incluindo configurações ADM e implantações de borda), informações do dispositivo (incluindo identificações de dispositivos, gêmeos de dispositivos, identidades de módulos e gêmeos de módulos).

Para pontos de extremidade importados com autenticação de identidade atribuída pelo sistema, o hub especificado deve ter as permissões corretas. Caso contrário, o comando falhará.

Os pontos de extremidade privados serão ignorados no processo de importação.

Para obter mais informações, consulte aka.ms/aziotcli-iot-hub-state.

az iot hub state import --state-file
                        [--acquire-policy-token]
                        [--aspects {arm, configurations, devices}]
                        [--auth-type {key, login}]
                        [--change-reference]
                        [--hub-name]
                        [--login]
                        [--replace]
                        [--resource-group]

Exemplos

Importe o estado suportado do arquivo especificado para o hub especificado.

az iot hub state import -n {iothub_name} -f {state_filename}

Importe o estado suportado do arquivo especificado para o hub especificado, substituindo o estado anterior do hub. Todos os certificados, configurações e dispositivos serão excluídos antes que o novo estado seja carregado.

az iot hub state import -n {iothub_name} -f {state_filename} -r

Importe apenas o modelo arm do arquivo especificado para o hub especificado. Observe que isso criará um novo hub se ele não existir. O arquivo pode conter os dispositivos e configurações, mas estes serão ignorados.

az iot hub state import -n {iothub_name} -g {resource_group} -f {state_filename} --aspects arm

Importe apenas os dispositivos e configurações do arquivo especificado para o hub especificado. Observe que isso NÃO criará um novo hub se ele não existir e o comando falhará. O arquivo pode conter o modelo arm, mas isso será ignorado.

az iot hub state import -n {iothub_name} -f {state_filename} --aspects devices configurations

Parâmetros Obrigatórios

--state-file -f

O caminho para o arquivo onde as informações de estado serão armazenadas.

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.

--acquire-policy-token

Aquisição automática de um token Azure Policy para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--aspects

Aspetos do Hub (separados por espaço).

Propriedade Valor
Valores aceites: arm, configurations, devices
--auth-type

Indica se a operação deve derivar automaticamente uma chave de política ou usar a sessão atual do Azure AD. Se o tipo de autenticação for login e o nome de host do recurso for fornecido, a pesquisa de recursos será ignorada, a menos que necessário. Você pode configurar o padrão usando az configure --defaults iothub-data-auth-type={auth-type-value}.

Propriedade Valor
Grupo de parâmetros: Access Control Arguments
Default value: key
Valores aceites: key, login
--change-reference

O ID de referência de alteração relacionado para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--hub-name -n

Nome do Hub IoT ou nome de host. Obrigatório se --login não for fornecido.

Propriedade Valor
Grupo de parâmetros: IoT Hub Identifier Arguments
--login -l

Este comando suporta uma cadeia de ligação de entidade com direitos para executar ações. Use para evitar login de sessão via "az login". Se forem fornecidos tanto uma entidade, cadeia de ligação como o nome, a cadeia de ligação tem prioridade. Obrigatório se --hub-name não for fornecido.

Propriedade Valor
Grupo de parâmetros: IoT Hub Identifier Arguments
--replace -r

Se esse sinalizador estiver definido, o comando excluirá os dispositivos, configurações e certificados atuais do hub de destino.

Propriedade Valor
Default value: False
--resource-group -g

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

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 hub state migrate

Experimental

O grupo de comando 'iot hub state' é experimental e está em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Migre o estado de um hub para outro sem salvar em um arquivo.

Se o aspeto arm for especificado, o hub será criado se não existir.

Por padrão, o estado migrado incluirá: modelo arm para hub, configurações de hub (incluindo configurações ADM e implantações de borda), informações do dispositivo (incluindo identificações de dispositivos, gêmeos de dispositivos, identidades de módulos e gêmeos de módulos).

Para pontos de extremidade migrados com autenticação de identidade atribuída pelo sistema, o hub especificado deve ter as permissões corretas. Caso contrário, o comando falhará.

Os pontos de extremidade privados serão ignorados no processo de migração.

Se você tiver problemas para migrar, use os comandos export e import para ter um arquivo como backup.

Para obter mais informações, consulte aka.ms/aziotcli-iot-hub-state.

az iot hub state migrate [--acquire-policy-token]
                         [--aspects {arm, configurations, devices}]
                         [--auth-type {key, login}]
                         [--change-reference]
                         [--destination-hub --dh]
                         [--destination-hub-login --dl]
                         [--destination-resource-group --dg]
                         [--og --origin-resource-group]
                         [--oh --origin-hub]
                         [--ol --origin-hub-login]
                         [--replace]

Exemplos

Migre o estado suportado do hub de origem para o hub de destino.

az iot hub state migrate --destination-hub {dest_hub_name} --origin-hub {orig_hub_name}

Migre o estado suportado do hub de origem para o hub de destino, substituindo o estado anterior do hub. Todos os certificados, configurações e dispositivos no hub de destino serão excluídos antes que o novo estado seja carregado.

az iot hub state migrate --destination-hub {dest_hub_name} --origin-hub {orig_hub_name} -r

Migre apenas o modelo arm do hub de origem para o hub de destino. Observe que isso criará um novo hub se o hub de destino não existir. O hub de origem pode conter os dispositivos e configurações, mas estes serão ignorados.

az iot hub state migrate --destination-hub {dest_hub_name} --destination-resource-group {dest_hub_resource_group} --origin-hub {orig_hub_name} --aspects arm

Migre apenas os dispositivos e as configurações do hub de origem para o hub de destino. Observe que isso NÃO criará um novo hub se o hub de destino não existir e o comando falhar. O modelo de braço para o hub de origem será ignorado.

az iot hub state migrate --destination-hub {dest_hub_name} --origin-hub {orig_hub_name} --aspects devices configurations

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.

--acquire-policy-token

Aquisição automática de um token Azure Policy para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--aspects

Aspetos do Hub (separados por espaço).

Propriedade Valor
Valores aceites: arm, configurations, devices
--auth-type

Indica se a operação deve derivar automaticamente uma chave de política ou usar a sessão atual do Azure AD. Se o tipo de autenticação for login e o nome de host do recurso for fornecido, a pesquisa de recursos será ignorada, a menos que necessário. Você pode configurar o padrão usando az configure --defaults iothub-data-auth-type={auth-type-value}.

Propriedade Valor
Grupo de parâmetros: Access Control Arguments
Default value: key
Valores aceites: key, login
--change-reference

O ID de referência de alteração relacionado para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--destination-hub --dh

Nome do Hub IoT para onde o estado do hub de origem será copiado.

Propriedade Valor
Grupo de parâmetros: IoT Hub Identifier Arguments
--destination-hub-login --dl

Este comando suporta uma cadeia de ligação de entidade com direitos para executar ações no hub de destino. Use para evitar o login de sessão via az login nesta Hub IoT instância. Se forem fornecidos tanto uma entidade, cadeia de ligação como o nome, a cadeia de ligação tem prioridade. Obrigatório se --destination-hub não for fornecido.

Propriedade Valor
Grupo de parâmetros: IoT Hub Identifier Arguments
--destination-resource-group --dg

Nome do grupo de recursos do Hub IoT para onde o estado do hub de origem será copiado. Se não for fornecido, irá utilizar o grupo de recursos do Origin Hub IoT.

Propriedade Valor
Grupo de parâmetros: IoT Hub Identifier Arguments
--og --origin-resource-group

Nome do grupo de recursos do Hub IoT que será copiado.

Propriedade Valor
Grupo de parâmetros: IoT Hub Identifier Arguments
--oh --origin-hub

Nome do Hub IoT, que será copiado.

Propriedade Valor
Grupo de parâmetros: IoT Hub Identifier Arguments
--ol --origin-hub-login

Este comando suporta uma cadeia de ligação de entidade com direitos para executar ações no hub de origem. Use para evitar o login de sessão via az login nesta Hub IoT instância. Se forem fornecidos tanto uma entidade, cadeia de ligação como o nome, a cadeia de ligação tem prioridade. Obrigatório se --origin-hub não for fornecido.

Propriedade Valor
Grupo de parâmetros: IoT Hub Identifier Arguments
--replace -r

Se esse sinalizador estiver definido, o comando excluirá os dispositivos, configurações e certificados atuais do hub de destino.

Propriedade Valor
Default value: False
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