Compartilhar via

az iot hub state

  • Habilitação

Note

Essa referência faz parte da extensão azure-iot para a CLI do Azure (versão 2.67.0 ou superior). A extensão instalará automaticamente a 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 suporte: https://aka.ms/CLI_refstatus

Gerencie o estado de um Hub IoT.

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

Comandos

Nome Description Tipo Status
az iot hub state export

Exporte o estado de um Hub IoT para um arquivo.

 Extension Experimental
az iot hub state import

Importe um estado de Hub de um arquivo para um Hub IoT.

 Extension Experimental
az iot hub state migrate

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

 Extension Experimental

az iot hub state export

Habilitação

O "estado do hub iot" do grupo de comandos é experimental e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Exporte o estado de um Hub IoT para um arquivo.

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 identidades de dispositivo, dispositivos gêmeos, identidades de módulo e módulos gêmeos).

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

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

Exemplos

Exporte o estado com suporte do hub especificado para o arquivo especificado.

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

Exporte o estado com suporte 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 Exigidos

--state-file -f

O caminho para o arquivo em que 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 se tornar obrigatórios para que o comando seja executado com sucesso.

--aspects

Aspectos do Hub (separados por espaço).

Propriedade Valor
Valores aceitos: 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 logon e o nome do host do recurso for fornecido, a pesquisa de recursos será ignorada, a menos que seja 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
Valor padrão: key
Valores aceitos: key, login
--hub-name -n

Nome ou nome do host do Hub IoT. Necessário se --login não for fornecido.

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

Esse comando dá suporte a uma cadeia de conexão de entidade com direitos para executar a ação. Use para evitar o logon da sessão por meio de "az login". Se uma cadeia de conexão de entidade e o nome forem fornecidos, a cadeia de conexã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
Valor padrão: False
--resource-group -g

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

Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor padrão: False

az iot hub state import

Habilitação

O "estado do hub iot" do grupo de comandos é experimental e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Importe um estado de Hub de um arquivo para um Hub IoT.

Se o aspecto 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 identidades de dispositivo, dispositivos gêmeos, identidades de módulo e módulos gêmeos).

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
                        [--aspects {arm, configurations, devices}]
                        [--auth-type {key, login}]
                        [--hub-name]
                        [--login]
                        [--replace]
                        [--resource-group]

Exemplos

Importe o estado com suporte do arquivo especificado para o hub especificado.

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

Importe o estado com suporte 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 de braço 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 as configurações, mas eles serão ignorados.

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

Importe apenas os dispositivos e as 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 de braço, mas isso será ignorado.

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

Parâmetros Exigidos

--state-file -f

O caminho para o arquivo em que 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 se tornar obrigatórios para que o comando seja executado com sucesso.

--aspects

Aspectos do Hub (separados por espaço).

Propriedade Valor
Valores aceitos: 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 logon e o nome do host do recurso for fornecido, a pesquisa de recursos será ignorada, a menos que seja 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
Valor padrão: key
Valores aceitos: key, login
--hub-name -n

Nome ou nome do host do Hub IoT. Necessário se --login não for fornecido.

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

Esse comando dá suporte a uma cadeia de conexão de entidade com direitos para executar a ação. Use para evitar o logon da sessão por meio de "az login". Se uma cadeia de conexão de entidade e o nome forem fornecidos, a cadeia de conexã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
Valor padrão: False
--resource-group -g

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

Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor padrão: False

az iot hub state migrate

Habilitação

O "estado do hub iot" do grupo de comandos é experimental e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

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

Se o aspecto 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 dispositivo, dispositivos gêmeos, identidades de módulo e módulos gêmeos).

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 [--aspects {arm, configurations, devices}]
                         [--auth-type {key, login}]
                         [--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 com suporte 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 com suporte 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 de braço 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 as configurações, mas eles 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 do 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 se tornar obrigatórios para que o comando seja executado com sucesso.

--aspects

Aspectos do Hub (separados por espaço).

Propriedade Valor
Valores aceitos: 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 logon e o nome do host do recurso for fornecido, a pesquisa de recursos será ignorada, a menos que seja 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
Valor padrão: key
Valores aceitos: key, login
--destination-hub --dh

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

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

Esse comando dá suporte a uma cadeia de conexão de entidade com direitos para executar a ação no hub de destino. Use para evitar o logon de sessão por meio de az login para esta instância do Hub IoT. Se uma cadeia de conexão de entidade e o nome forem fornecidos, a cadeia de conexã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 o qual o estado do hub de origem será copiado. Se não for fornecido, usará o grupo de recursos do Hub IoT de origem.

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

Esse comando dá suporte a uma cadeia de conexão de entidade com direitos para executar a ação no hub de origem. Use para evitar o logon de sessão por meio de az login para esta instância do Hub IoT. Se uma cadeia de conexão de entidade e o nome forem fornecidos, a cadeia de conexão tem prioridade. Necessá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
Valor padrão: False
Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor padrão: False