az iot ops secretsync

Note

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

實例秘密同步管理。

命令

名稱	Description	類型	狀態
az iot ops secretsync disable	停用實例的秘密同步處理。	Extension	GA
az iot ops secretsync enable	啟用實例的秘密同步處理。	Extension	GA
az iot ops secretsync list	列出與實例相關聯的秘密同步設定。	Extension	GA

az iot ops secretsync disable

停用實例的秘密同步處理。

所有與實例相關聯的秘密提供者類別，以及與秘密提供者類別相關聯的所有秘密同步處理都會被刪除。

az iot ops secretsync disable --instance
                              --resource-group
                              [--yes {false, true}]

範例

停用實例的秘密同步處理。

az iot ops secretsync disable --instance myinstance -g myresourcegroup

必要參數

--instance -i -n

IoT 作業實例名稱。

--resource-group -g

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

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--yes -y

在沒有提示的情況下確認 [y]es。 適用於 CI 和自動化案例。

屬性	值
接受的值:	false, true

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az iot ops secretsync enable

啟用實例的秘密同步處理。

此作業會處理身分識別同盟、針對目標 Key Vault 建立預設秘密提供者類別和角色指派（Key Vault 讀取者、Key Vault 秘密使用者）的受控識別。

流程會從確保 Key Vault 角色指派開始，如果它們不存在，則會套用它們。 如果無法進行角色指派，將會引發錯誤。 如有必要，可透過 --custom-role-id 使用自定義角色來取代內建角色。 或者，您可以使用 --skip-ra 旗標來略過角色指派。

az iot ops secretsync enable --instance
                             --kv-resource-id
                             --mi-user-assigned
                             --resource-group
                             [--custom-role-id]
                             [--self-hosted-issuer {false, true}]
                             [--skip-ra {false, true}]
                             [--spc]
                             [--tags]

範例

啟用 金鑰保存庫 秘密同步的目標實例。

az iot ops secretsync enable --instance myinstance -g myresourcegroup --mi-user-assigned $UA_MI_RESOURCE_ID --kv-resource-id $KEYVAULT_RESOURCE_ID

建立預設秘密提供者類別時啟用秘密同步處理並套用標記。

az iot ops secretsync enable --instance myinstance -g myresourcegroup --mi-user-assigned $UA_MI_RESOURCE_ID --kv-resource-id $KEYVAULT_RESOURCE_ID --tags a=b c=d

針對 Key Vault 啟用與自定義角色識別碼的秘密同步處理。

az iot ops secretsync enable --instance myinstance -g myresourcegroup --mi-user-assigned $UA_MI_RESOURCE_ID --kv-resource-id $KEYVAULT_RESOURCE_ID --custom-role-id $CUSTOM_ROLE_ID

旗標的使用方式略過Key Vault角色指派。

az iot ops secretsync enable --instance myinstance -g myresourcegroup --mi-user-assigned $UA_MI_RESOURCE_ID --kv-resource-id $KEYVAULT_RESOURCE_ID --skip-ra

必要參數

--instance -i -n

IoT 作業實例名稱。

--kv-resource-id

金鑰保存庫 ARM 資源識別碼。

--mi-user-assigned

要與實例搭配使用之所需使用者指派受控識別的資源標識碼。

--resource-group -g

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

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--custom-role-id

完整角色定義標識符的格式如下：/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/roleDefinitions/{roleId}。

屬性	值
參數群組:	Role Assignment Arguments

--self-hosted-issuer

使用自我裝載的 oidc 簽發者進行同盟。

屬性	值
接受的值:	false, true

--skip-ra

使用時，將會略過作業的角色指派步驟。

屬性	值
參數群組:	Role Assignment Arguments
接受的值:	false, true

--spc

啟用秘密同步處理的預設秘密提供者類別名稱。 默認模式為 'spc-ops-{hash}'。

--tags

以空格分隔的標記：key[=value] [key[=value] ...]。使用 「清除現有的標記」。

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az iot ops secretsync list

列出與實例相關聯的秘密同步設定。

az iot ops secretsync list --instance
                           --resource-group

範例

列出與實例相關聯的秘密同步設定。

az iot ops secretsync list --instance myinstance -g myresourcegroup

必要參數

--instance -i -n

IoT 作業實例名稱。

--resource-group -g

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

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False