az iot hub state

  • Deneysel

Note

Bu başvuru, Azure CLI (sürüm 2.70.0 veya üzeri) için azure-iot uzantısının bir parçasıdır. uzantı, az iot hub state komutunu ilk kez çalıştırdığınızda otomatik olarak yüklenir. Uzantılar hakkında daha fazla bilgi edinin.

Bu komut grubu deneyseldir ve geliştirme aşamasındadır. Başvuru ve destek düzeyleri: https://aka.ms/CLI_refstatus

bir IoT Hub durumunu yönetin.

Daha fazla bilgi için bkz. aka.ms/aziotcli-iot-hub-state.

Komutlar

Name Description Tür Durum
az iot hub state export

IoT Hub durumunu bir dosyaya aktarın.

 Extension Experimental
az iot hub state import

Bir dosyadan IoT Hub Hub durumunu içeri aktar.

 Extension Experimental
az iot hub state migrate

Bir dosyaya kaydetmeden bir hub'ın durumunu başka bir hub'a geçirin.

 Extension Experimental

az iot hub state export

Deneysel

'iot hub state' komut grubu deneyseldir ve geliştirme aşamasındadır. Başvuru ve destek düzeyleri: https://aka.ms/CLI_refstatus

IoT Hub durumunu bir dosyaya aktarın.

Dışarı aktarılan durum varsayılan olarak şunları içerir: hub için arm şablonu, hub yapılandırmaları (ADM yapılandırmaları ve uç dağıtımları dahil), cihaz bilgileri (cihaz kimlikleri, cihaz ikizleri, modül kimlikleri ve modül ikizleri dahil).

Daha fazla bilgi için bkz. 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]

Örnekler

Belirtilen hub'ın desteklenen durumunu belirtilen dosyaya aktarın.

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

Belirtilen hub'ın desteklenen durumunu belirtilen dosyaya aktarın ve dosya içeriğinin üzerine yazın.

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

Belirtilen hub'ın yalnızca cihazlarını ve yapılandırmalarını belirtilen dosyaya aktarın.

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

Gerekli Parametreler

--state-file -f

Durum bilgilerinin depolanacağı dosyanın yolu.

İsteğe Bağlı Parametreler

Aşağıdaki parametreler isteğe bağlıdır, ancak bağlama bağlı olarak komutun başarıyla yürütülmesi için bir veya daha fazla parametre gerekli olabilir.

--acquire-policy-token

Bu kaynak işlemi için otomatik olarak bir Azure İlkesi belirteci alma.

Özellik Değer
Parametre grubu: Global Policy Arguments
--aspects

Hub Yönleri (boşlukla ayrılmış).

Özellik Değer
Kabul edilen değerler: arm, configurations, devices
--auth-type

İşlemin bir ilke anahtarını otomatik olarak türetmesi mi yoksa geçerli Azure AD oturumunu mu kullanması gerektiğini gösterir. Kimlik doğrulama türü oturum açma bilgisiyse ve kaynak ana bilgisayar adı sağlanmışsa, gerekmedikçe kaynak araması atlanır. kullanarak varsayılanı az configure --defaults iothub-data-auth-type={auth-type-value}yapılandırabilirsiniz.

Özellik Değer
Parametre grubu: Access Control Arguments
Default value: key
Kabul edilen değerler: key, login
--change-reference

Bu kaynak işlemi için ilgili değişiklik başvuru kimliği.

Özellik Değer
Parametre grubu: Global Policy Arguments
--hub-name -n

IoT Hub adı veya ana bilgisayar adı. --login sağlanmadıysa gereklidir.

Özellik Değer
Parametre grubu: IoT Hub Identifier Arguments
--login -l

Bu komut, eylem gerçekleştirme haklarına sahip bir varlık bağlantı dizesi destekler. "az login" aracılığıyla oturum açmaktan kaçınmak için kullanın. Hem varlık bağlantı dizesi hem de ad sağlanırsa, bağlantı dizesi öncelik alır. --hub-name sağlanmadıysa gereklidir.

Özellik Değer
Parametre grubu: IoT Hub Identifier Arguments
--replace -r

Bu bayrak ayarlanırsa, komut çıktı dosyasının içeriğinin üzerine yazar.

Özellik Değer
Default value: False
--resource-group -g

Kaynak grubunun adı. az configure --defaults group=<name>kullanarak varsayılan grubu yapılandırabilirsiniz.

Global Parametreler
--debug

Tüm hata ayıklama günlüklerini göstermek için günlük ayrıntı düzeyini artırın.

Özellik Değer
Default value: False
--help -h

Bu yardım iletisini göster ve çık.

--only-show-errors

Yalnızca hataları gösterir ve uyarıları gizler.

Özellik Değer
Default value: False
--output -o

Çıkış biçimi.

Özellik Değer
Default value: json
Kabul edilen değerler: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath sorgu dizesi. Daha fazla bilgi ve örnek için bkz. http://jmespath.org/.

--subscription

Aboneliğin adı veya kimliği. az account set -s NAME_OR_IDkullanarak varsayılan aboneliği yapılandırabilirsiniz.

--verbose

Günlük ayrıntı düzeyini artırın. Tam hata ayıklama günlükleri için --debug komutunu kullanın.

Özellik Değer
Default value: False

az iot hub state import

Deneysel

'iot hub state' komut grubu deneyseldir ve geliştirme aşamasındadır. Başvuru ve destek düzeyleri: https://aka.ms/CLI_refstatus

Bir dosyadan IoT Hub Hub durumunu içeri aktar.

Arm yönü belirtilirse, merkez yoksa oluşturulur.

Varsayılan olarak, içeri aktarılan durum şunları içerir: hub için arm şablonu, hub yapılandırmaları (ADM yapılandırmaları ve uç dağıtımları dahil), cihaz bilgileri (cihaz kimlikleri, cihaz ikizleri, modül kimlikleri ve modül ikizleri dahil).

Sistem tarafından atanan kimlik kimlik doğrulamasına sahip içeri aktarılan uç noktalar için, belirtilen hub'ın doğru izinlere sahip olması gerekir. Aksi takdirde komut başarısız olur.

İçeri aktarma işleminde özel uç noktalar yoksayılır.

Daha fazla bilgi için bkz. 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]

Örnekler

Desteklenen durumu belirtilen dosyadan belirtilen hub'a aktarın.

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

Desteklenen durumu belirtilen dosyadan belirtilen hub'a aktarın ve hub'ın önceki durumunun üzerine yazın. Yeni durum karşıya yüklenmeden önce tüm sertifikalar, yapılandırmalar ve cihazlar silinir.

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

Belirtilen dosyadan belirtilen hub'a yalnızca arm şablonunu içeri aktarın. Yoksa bunun yeni bir hub oluşturacağını unutmayın. Dosya, cihazları ve yapılandırmaları içerebilir, ancak bunlar yoksayılır.

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

Yalnızca belirtilen dosyadaki cihazları ve yapılandırmaları belirtilen hub'a aktarın. Bu, yoksa yeni bir hub oluşturmaz ve komutun başarısız olacağını unutmayın. Dosya arm şablonunu içerebilir, ancak bu yoksayılır.

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

Gerekli Parametreler

--state-file -f

Durum bilgilerinin depolanacağı dosyanın yolu.

İsteğe Bağlı Parametreler

Aşağıdaki parametreler isteğe bağlıdır, ancak bağlama bağlı olarak komutun başarıyla yürütülmesi için bir veya daha fazla parametre gerekli olabilir.

--acquire-policy-token

Bu kaynak işlemi için otomatik olarak bir Azure İlkesi belirteci alma.

Özellik Değer
Parametre grubu: Global Policy Arguments
--aspects

Hub Yönleri (boşlukla ayrılmış).

Özellik Değer
Kabul edilen değerler: arm, configurations, devices
--auth-type

İşlemin bir ilke anahtarını otomatik olarak türetmesi mi yoksa geçerli Azure AD oturumunu mu kullanması gerektiğini gösterir. Kimlik doğrulama türü oturum açma bilgisiyse ve kaynak ana bilgisayar adı sağlanmışsa, gerekmedikçe kaynak araması atlanır. kullanarak varsayılanı az configure --defaults iothub-data-auth-type={auth-type-value}yapılandırabilirsiniz.

Özellik Değer
Parametre grubu: Access Control Arguments
Default value: key
Kabul edilen değerler: key, login
--change-reference

Bu kaynak işlemi için ilgili değişiklik başvuru kimliği.

Özellik Değer
Parametre grubu: Global Policy Arguments
--hub-name -n

IoT Hub adı veya ana bilgisayar adı. --login sağlanmadıysa gereklidir.

Özellik Değer
Parametre grubu: IoT Hub Identifier Arguments
--login -l

Bu komut, eylem gerçekleştirme haklarına sahip bir varlık bağlantı dizesi destekler. "az login" aracılığıyla oturum açmaktan kaçınmak için kullanın. Hem varlık bağlantı dizesi hem de ad sağlanırsa, bağlantı dizesi öncelik alır. --hub-name sağlanmadıysa gereklidir.

Özellik Değer
Parametre grubu: IoT Hub Identifier Arguments
--replace -r

Bu bayrak ayarlanırsa, komut hedef hub'ın geçerli cihazlarını, yapılandırmalarını ve sertifikalarını siler.

Özellik Değer
Default value: False
--resource-group -g

Kaynak grubunun adı. az configure --defaults group=<name>kullanarak varsayılan grubu yapılandırabilirsiniz.

Global Parametreler
--debug

Tüm hata ayıklama günlüklerini göstermek için günlük ayrıntı düzeyini artırın.

Özellik Değer
Default value: False
--help -h

Bu yardım iletisini göster ve çık.

--only-show-errors

Yalnızca hataları gösterir ve uyarıları gizler.

Özellik Değer
Default value: False
--output -o

Çıkış biçimi.

Özellik Değer
Default value: json
Kabul edilen değerler: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath sorgu dizesi. Daha fazla bilgi ve örnek için bkz. http://jmespath.org/.

--subscription

Aboneliğin adı veya kimliği. az account set -s NAME_OR_IDkullanarak varsayılan aboneliği yapılandırabilirsiniz.

--verbose

Günlük ayrıntı düzeyini artırın. Tam hata ayıklama günlükleri için --debug komutunu kullanın.

Özellik Değer
Default value: False

az iot hub state migrate

Deneysel

'iot hub state' komut grubu deneyseldir ve geliştirme aşamasındadır. Başvuru ve destek düzeyleri: https://aka.ms/CLI_refstatus

Bir dosyaya kaydetmeden bir hub'ın durumunu başka bir hub'a geçirin.

Arm yönü belirtilirse, merkez yoksa oluşturulur.

Varsayılan olarak, geçirilen durum şunları içerir: hub için arm şablonu, hub yapılandırmaları (ADM yapılandırmaları ve uç dağıtımları dahil), cihaz bilgileri (cihaz kimlikleri, cihaz ikizleri, modül kimlikleri ve modül ikizleri dahil).

Sistem tarafından atanan kimlik kimlik doğrulamasına sahip geçirilen uç noktalar için belirtilen hub'ın doğru izinlere sahip olması gerekir. Aksi takdirde komut başarısız olur.

Geçiş işleminde özel uç noktalar yoksayılır.

Geçişte sorun yaşıyorsanız, bir dosyanın yedeklenmesi için dışarı ve içeri aktarma komutlarını kullanın.

Daha fazla bilgi için bkz. 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]

Örnekler

Kaynak hub'ın desteklenen durumunu hedef hub'a geçirin.

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

Başlangıç hub'ının desteklenen durumunu hedef hub'a geçirerek hub'ın önceki durumunun üzerine yazın. Yeni durum karşıya yüklenmeden önce hedef hub'daki tüm sertifikalar, yapılandırmalar ve cihazlar silinir.

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

Yalnızca arm şablonunu kaynak hub'dan hedef hub'a geçirin. Hedef hub yoksa bunun yeni bir hub oluşturacağını unutmayın. Kaynak hub'ı cihazları ve yapılandırmaları içerebilir, ancak bunlar yoksayılır.

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

Yalnızca kaynak hub'dan hedef hub'a cihazları ve yapılandırmaları geçirin. Hedef hub yoksa ve komut başarısız olursa bunun yeni bir hub oluşturmayacağını unutmayın. Kaynak hub'ına yönelik arm şablonu yoksayılır.

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

İsteğe Bağlı Parametreler

Aşağıdaki parametreler isteğe bağlıdır, ancak bağlama bağlı olarak komutun başarıyla yürütülmesi için bir veya daha fazla parametre gerekli olabilir.

--acquire-policy-token

Bu kaynak işlemi için otomatik olarak bir Azure İlkesi belirteci alma.

Özellik Değer
Parametre grubu: Global Policy Arguments
--aspects

Hub Yönleri (boşlukla ayrılmış).

Özellik Değer
Kabul edilen değerler: arm, configurations, devices
--auth-type

İşlemin bir ilke anahtarını otomatik olarak türetmesi mi yoksa geçerli Azure AD oturumunu mu kullanması gerektiğini gösterir. Kimlik doğrulama türü oturum açma bilgisiyse ve kaynak ana bilgisayar adı sağlanmışsa, gerekmedikçe kaynak araması atlanır. kullanarak varsayılanı az configure --defaults iothub-data-auth-type={auth-type-value}yapılandırabilirsiniz.

Özellik Değer
Parametre grubu: Access Control Arguments
Default value: key
Kabul edilen değerler: key, login
--change-reference

Bu kaynak işlemi için ilgili değişiklik başvuru kimliği.

Özellik Değer
Parametre grubu: Global Policy Arguments
--destination-hub --dh

Kaynak hub durumunun kopyalanacağı IoT Hub adı.

Özellik Değer
Parametre grubu: IoT Hub Identifier Arguments
--destination-hub-login --dl

Bu komut, hedef hub'da eylem gerçekleştirme haklarına sahip bir varlık bağlantı dizesi destekler. Bu IoT Hub örneğinin az login aracılığıyla oturum açmasını önlemek için kullanın. Hem varlık bağlantı dizesi hem de ad sağlanırsa, bağlantı dizesi öncelik alır. --destination-hub sağlanmadıysa gereklidir.

Özellik Değer
Parametre grubu: IoT Hub Identifier Arguments
--destination-resource-group --dg

Kaynak hub durumunun kopyalanacağı IoT Hub kaynak grubunun adı. Sağlanmadıysa, kaynak IoT Hub kaynak grubunu kullanır.

Özellik Değer
Parametre grubu: IoT Hub Identifier Arguments
--og --origin-resource-group

Kopyalanacak IoT Hub kaynak grubunun adı.

Özellik Değer
Parametre grubu: IoT Hub Identifier Arguments
--oh --origin-hub

Kopyalanacak IoT Hub adı.

Özellik Değer
Parametre grubu: IoT Hub Identifier Arguments
--ol --origin-hub-login

Bu komut, kaynak hub'da eylem gerçekleştirme haklarına sahip bir varlık bağlantı dizesi destekler. Bu IoT Hub örneğinin az login aracılığıyla oturum açmasını önlemek için kullanın. Hem varlık bağlantı dizesi hem de ad sağlanırsa, bağlantı dizesi öncelik alır. --origin-hub sağlanmadıysa gereklidir.

Özellik Değer
Parametre grubu: IoT Hub Identifier Arguments
--replace -r

Bu bayrak ayarlanırsa, komut hedef hub'ın geçerli cihazlarını, yapılandırmalarını ve sertifikalarını siler.

Özellik Değer
Default value: False
Global Parametreler
--debug

Tüm hata ayıklama günlüklerini göstermek için günlük ayrıntı düzeyini artırın.

Özellik Değer
Default value: False
--help -h

Bu yardım iletisini göster ve çık.

--only-show-errors

Yalnızca hataları gösterir ve uyarıları gizler.

Özellik Değer
Default value: False
--output -o

Çıkış biçimi.

Özellik Değer
Default value: json
Kabul edilen değerler: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath sorgu dizesi. Daha fazla bilgi ve örnek için bkz. http://jmespath.org/.

--subscription

Aboneliğin adı veya kimliği. az account set -s NAME_OR_IDkullanarak varsayılan aboneliği yapılandırabilirsiniz.

--verbose

Günlük ayrıntı düzeyini artırın. Tam hata ayıklama günlükleri için --debug komutunu kullanın.

Özellik Değer
Default value: False