az iot dps policy

管理Azure IoT 中樞裝置布建服務實例的共用存取原則。

命令

名稱	Description	類型	狀態
az iot dps policy create	在 Azure IoT 中樞裝置佈建服務執行個體中建立新的共用存取原則。	核心	GA
az iot dps policy delete	在 Azure IoT 中樞裝置佈建服務執行個體中刪除共用存取原則。	核心	GA
az iot dps policy list	在 Azure IoT 中樞裝置佈建服務執行個體中列出所有共用存取原則。	核心	GA
az iot dps policy show	在Azure IoT 中樞裝置布建服務實例中顯示共用存取原則的詳細資料。	核心	GA
az iot dps policy update	在 Azure IoT 中樞裝置佈建服務執行個體中更新共用存取原則。	核心	GA

az iot dps policy create

在 Azure IoT 中樞裝置佈建服務執行個體中建立新的共用存取原則。

az iot dps policy create --dps-name
                         --pn
                         --rights {DeviceConnect, EnrollmentRead, EnrollmentWrite, RegistrationStatusRead, RegistrationStatusWrite, ServiceConfig}
                         [--no-wait]
                         [--primary-key]
                         [--resource-group]
                         [--secondary-key]

範例

在具有 EnrollmentRead 許可權的Azure IoT 中樞裝置布建服務實例中建立新的共用存取原則

az iot dps policy create --dps-name MyDps --resource-group MyResourceGroup --policy-name MyPolicy --rights EnrollmentRead

必要參數

--dps-name -n

IoT 中樞裝置布建服務名稱。

--pn --policy-name

DPS 存取原則的易記名稱。

--rights -r

IoT 中樞裝置布建服務的存取權限。 針對多個許可權使用空格分隔清單。

接受的值: DeviceConnect, EnrollmentRead, EnrollmentWrite, RegistrationStatusRead, RegistrationStatusWrite, ServiceConfig

選擇性參數

--no-wait

請勿等候長時間執行的作業完成。

預設值: False

--primary-key

主要 SAS 金鑰值。

--resource-group -g

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

--secondary-key

次要 SAS 金鑰值。

全域參數

--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 dps policy delete

在 Azure IoT 中樞裝置佈建服務執行個體中刪除共用存取原則。

az iot dps policy delete --dps-name
                         --pn
                         [--no-wait]
                         [--resource-group]

範例

刪除Azure IoT 中樞裝置布建服務實例 'MyDps' 中的共用存取原則 'MyPolicy'

az iot dps policy delete --dps-name MyDps --resource-group MyResourceGroup --policy-name MyPolicy

必要參數

--dps-name -n

IoT 中樞裝置布建服務名稱。

--pn --policy-name

DPS 存取原則的易記名稱。

選擇性參數

--no-wait

請勿等候長時間執行的作業完成。

預設值: 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 dps policy list

在 Azure IoT 中樞裝置佈建服務執行個體中列出所有共用存取原則。

az iot dps policy list --dps-name
                       [--resource-group]

範例

列出 Azure IoT 中樞 裝置布建服務實例 'MyDps' 中 MyDps 中的所有共用存取原則

az iot dps policy list --dps-name MyDps --resource-group MyResourceGroup

必要參數

--dps-name -n

IoT 中樞裝置布建服務名稱。

選擇性參數

--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 dps policy show

在Azure IoT 中樞裝置布建服務實例中顯示共用存取原則的詳細資料。

az iot dps policy show --dps-name
                       --pn
                       [--resource-group]

範例

在 Azure IoT 中樞 裝置布建服務實例 'MyDps' 中顯示共用存取原則 'MyPolicy' 的詳細資料

az iot dps policy show --dps-name MyDps --resource-group MyResourceGroup --policy-name MyPolicy

必要參數

--dps-name -n

IoT 中樞裝置布建服務名稱。

--pn --policy-name

DPS 存取原則的易記名稱。

選擇性參數

--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 dps policy update

在 Azure IoT 中樞裝置佈建服務執行個體中更新共用存取原則。

az iot dps policy update --dps-name
                         --pn
                         [--no-wait]
                         [--primary-key]
                         [--resource-group]
                         [--rights {DeviceConnect, EnrollmentRead, EnrollmentWrite, RegistrationStatusRead, RegistrationStatusWrite, ServiceConfig}]
                         [--secondary-key]

範例

使用 EnrollmentWrite 許可權更新Azure IoT 中樞裝置布建服務實例中的共用存取原則 'MyPolicy'

az iot dps policy update --dps-name MyDps --resource-group MyResourceGroup --policy-name MyPolicy --rights EnrollmentWrite

必要參數

--dps-name -n

IoT 中樞裝置布建服務名稱。

--pn --policy-name

DPS 存取原則的易記名稱。

選擇性參數

--no-wait

請勿等候長時間執行的作業完成。

預設值: False

--primary-key

主要 SAS 金鑰值。

--resource-group -g

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

--rights -r

IoT 中樞裝置布建服務的存取權限。 針對多個許可權使用空格分隔清單。

接受的值: DeviceConnect, EnrollmentRead, EnrollmentWrite, RegistrationStatusRead, RegistrationStatusWrite, ServiceConfig

--secondary-key

次要 SAS 金鑰值。

全域參數

--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 來取得完整偵錯記錄。