az iot hub state

注意

此參考是 Azure CLI 的 azure-iot 延伸模組的一部分 （2.37.0 版或更高版本）。 擴充功能會在您第一次執行 az iot hub state 命令時自動安裝。 深入了解擴充功能。

此命令群組是實驗性且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

管理IoT 中樞的狀態。

如需詳細資訊，請參閱 aka.ms/aziotcli-iot-hub-state。

命令

名稱	Description	類型	狀態
az iot hub state export	將IoT 中樞的狀態匯出至檔案。	擴充	實驗性
az iot hub state import	將中樞狀態從檔案匯入至IoT 中樞。	擴充	實驗性
az iot hub state migrate	將一個中樞的狀態移轉至另一個中樞，而不儲存至檔案。	擴充	實驗性

az iot hub state export

實驗

命令群組 「iot 中樞狀態」是實驗性且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

將IoT 中樞的狀態匯出至檔案。

根據預設，匯出的狀態會包括：中樞的 arm 範本、中樞設定（包括 ADM 組態和邊緣部署）、裝置資訊（包括裝置身分識別、裝置對應項、模組身分識別和模組對應項）。

如需詳細資訊，請參閱 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]

範例

將指定中樞的支援狀態匯出至指定的檔案。

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

將指定中樞的支援狀態匯出至指定的檔案，並覆寫檔案內容。

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

僅將指定中樞的裝置和組態匯出至指定的檔案。

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

必要參數

--state-file -f

將儲存狀態資訊之檔案的路徑。

選擇性參數

--aspects

中樞層面 （空格分隔）。

接受的值: arm, configurations, devices

--auth-type

指出作業是否應該自動衍生原則金鑰，或使用目前的 Azure AD 會話。 如果驗證類型是登入，而且會提供資源主機名稱，除非需要，否則將會略過資源查閱。您可以使用 來設定預設值 az configure --defaults iothub-data-auth-type=<auth-type-value> 。

接受的值: key, login

預設值: key

--hub-name -n

IoT 中樞名稱或主機名稱。 如果未提供 --login，則為必要項。

--login -l

此命令支援具有執行動作許可權的實體連接字串。 使用 來避免透過 「az login」 的會話登入。 如果提供實體連接字串和名稱，則連接字串優先。 如果未提供 --hub-name，則為必要專案。

--replace -r

如果已設定此旗標，命令將會覆寫輸出檔案的內容。

預設值: False

--resource-group -g

資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name> 。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az iot hub state import

實驗

命令群組 「iot 中樞狀態」是實驗性且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

將中樞狀態從檔案匯入至IoT 中樞。

如果指定 arm 層面，則如果中樞不存在，則會建立中樞。

根據預設，匯入的狀態會包括：中樞的 arm 範本、中樞組態（包括 ADM 組態和邊緣部署）、裝置資訊（包括裝置身分識別、裝置對應項、模組身分識別和模組對應項）。

針對具有系統指派身分識別驗證的匯入端點，指定的中樞必須具有正確的許可權。 否則命令將會失敗。

匯入程式中會忽略私人端點。

如需詳細資訊，請參閱 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]

範例

將支援的狀態從指定的檔案匯入至指定的中樞。

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

將支援的狀態從指定的檔案匯入至指定的中樞，並覆寫中樞先前的狀態。 上傳新狀態之前，將會刪除所有憑證、組態和裝置。

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

僅將 arm 範本從指定的檔案匯入至指定的中樞。 請注意，如果新中樞不存在，這會建立新的中樞。 檔案可能包含裝置和組態，但將會忽略這些裝置和組態。

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

只將裝置和組態從指定的檔案匯入至指定的中樞。 請注意，如果新中樞不存在，此命令將會失敗，則不會建立新的中樞。 檔案可能包含 arm 範本，但將會予以忽略。

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

必要參數

--state-file -f

將儲存狀態資訊之檔案的路徑。

選擇性參數

--aspects

中樞層面 （空格分隔）。

接受的值: arm, configurations, devices

--auth-type

指出作業是否應該自動衍生原則金鑰，或使用目前的 Azure AD 會話。 如果驗證類型是登入，而且會提供資源主機名稱，除非需要，否則將會略過資源查閱。您可以使用 來設定預設值 az configure --defaults iothub-data-auth-type=<auth-type-value> 。

接受的值: key, login

預設值: key

--hub-name -n

IoT 中樞名稱或主機名稱。 如果未提供 --login，則為必要項。

--login -l

此命令支援具有執行動作許可權的實體連接字串。 使用 來避免透過 「az login」 的會話登入。 如果提供實體連接字串和名稱，則連接字串優先。 如果未提供 --hub-name，則為必要專案。

--replace -r

如果已設定此旗標，命令將會刪除目的地中樞的目前裝置、組態和憑證。

預設值: False

--resource-group -g

資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name> 。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az iot hub state migrate

實驗

命令群組 「iot 中樞狀態」是實驗性且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

將一個中樞的狀態移轉至另一個中樞，而不儲存至檔案。

如果指定 arm 層面，則如果中樞不存在，則會建立中樞。

根據預設，已移轉的狀態會包括：中樞的 arm 範本、中樞設定（包括 ADM 設定和邊緣部署）、裝置資訊（包括裝置身分識別、裝置對應項、模組身分識別和模組對應項）。

針對具有系統指派身分識別驗證的已移轉端點，指定的中樞必須具有正確的許可權。 否則命令將會失敗。

移轉程式中會忽略私人端點。

如果您在移轉時遇到問題，請使用匯出和匯入命令將檔案作為備份。

如需詳細資訊，請參閱 aka.ms/aziotcli-iot-hub-state。

az iot hub state migrate [--aspects {arm, configurations, devices}]
                         [--auth-type {key, login}]
                         [--destination-hub]
                         [--destination-hub-login]
                         [--destination-resource-group]
                         [--og]
                         [--oh]
                         [--ol]
                         [--replace]

範例

將原始中樞支援的狀態移轉至目的地中樞。

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

將原始中樞支援的狀態移轉至目的地中樞，並覆寫中樞先前的狀態。 在上傳新狀態之前，將會刪除目的地中樞中的所有憑證、組態和裝置。

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

只將 arm 範本從原始中樞移轉至目的地中樞。 請注意，如果目的地中樞不存在，這會建立新的中樞。 原始中樞可能包含裝置和組態，但將會忽略這些裝置。

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

僅將裝置和組態從來源中樞移轉至目的地中樞。 請注意，如果目的地中樞不存在，此命令將會失敗，則不會建立新的中樞。 系統會忽略原始中樞的 arm 範本。

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

選擇性參數

--aspects

中樞層面 （空格分隔）。

接受的值: arm, configurations, devices

--auth-type

指出作業是否應該自動衍生原則金鑰，或使用目前的 Azure AD 會話。 如果驗證類型是登入，而且會提供資源主機名稱，除非需要，否則將會略過資源查閱。您可以使用 來設定預設值 az configure --defaults iothub-data-auth-type=<auth-type-value> 。

接受的值: key, login

預設值: key

--destination-hub --dh

將複製到來源中樞狀態的IoT 中樞名稱。

--destination-hub-login --dl

此命令支援具有在目的地中樞上執行動作許可權的實體連接字串。 使用 來避免此IoT 中樞實例的會話登入 az login 。 如果提供實體連接字串和名稱，則連接字串優先。 如果未提供 --destination-hub，則為必要專案。

--destination-resource-group --dg

來源中樞狀態要複製到其中之IoT 中樞資源組名。 如果未提供，則會使用來源IoT 中樞的資源群組。

--og --origin-resource-group

要複製之IoT 中樞的資源群組名稱。

--oh --origin-hub

將複製之IoT 中樞的名稱。

--ol --origin-hub-login

此命令支援具有在來源中樞上執行動作之許可權的實體連接字串。 使用 來避免此IoT 中樞實例的會話登入 az login 。 如果提供實體連接字串和名稱，則連接字串優先。 如果未提供 --origin-hub，則為必要專案。

--replace -r

如果已設定此旗標，命令將會刪除目的地中樞的目前裝置、組態和憑證。

預設值: False

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。