Microsoft.Devices provisioningServices 2020-01-01

• 最新
• 2025-02-01-preview
• 2023-03-01-preview
• 2022-12-12
• 2022-02-05
• 2021-10-15
• 2020-09-01-preview
• 2020-03-01
• 2020-01-01
• 2018-01-22
• 2017-11-15
• 2017-08-21-preview

Bicep 資源定義

provisioningServices 資源類型可以使用目標作業來部署：

• 資源群組 - 請參閱 資源群組部署命令

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.Devices/provisioningServices 資源，請將下列 Bicep 新增至您的範本。

resource symbolicname 'Microsoft.Devices/provisioningServices@2020-01-01' = {
  etag: 'string'
  location: 'string'
  name: 'string'
  properties: {
    allocationPolicy: 'string'
    authorizationPolicies: [
      {
        keyName: 'string'
        primaryKey: 'string'
        rights: 'string'
        secondaryKey: 'string'
      }
    ]
    iotHubs: [
      {
        allocationWeight: int
        applyAllocationPolicy: bool
        connectionString: 'string'
        location: 'string'
      }
    ]
    ipFilterRules: [
      {
        action: 'string'
        filterName: 'string'
        ipMask: 'string'
        target: 'string'
      }
    ]
    provisioningState: 'string'
    state: 'string'
  }
  sku: {
    capacity: int
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

屬性值

IotDpsPropertiesDescription

名字	描述	價值
allocationPolicy	此布建服務要使用的配置原則。	'GeoLatency' 'Hashed' 'Static'
authorizationPolicies	布建服務的授權金鑰清單。	SharedAccessSignatureAuthorizationRuleAccessRightsDescription[]
iotHubs	與此布建服務相關聯的IoT中樞清單。	IotHubDefinitionDescription[]
ipFilterRules	IP 篩選規則。	IpFilterRule[]
provisioningState	布建服務的ARM布建狀態。	字串
州	布建服務的目前狀態。	'啟用' 'ActivationFailed' 'Active' 'Deleted' '刪除' 'DeletionFailed' 'FailingOver' 'FailoverFailed' '繼續' 'Suspended' 'Suspending' 'Transitioning'

IotDpsSkuInfo

名字	描述	價值
能力	要布建的單位數目	int
名字	Sku 名稱。	'S1'

IotHubDefinitionDescription

名字	描述	價值
allocationWeight	要套用指定 iot h 的權數。	int
applyAllocationPolicy	用於套用allocationPolicy或不適用於指定的iot中樞的旗標。	bool
connectionString	連接字串 og ioT 中樞。	字串 （必要）
位置	IoT 中樞的ARM區域。	字串 （必要）

IpFilterRule

名字	描述	價值
行動	此規則所擷取要求所需的動作。	'Accept' '拒絕' （必要）
filterName	IP 篩選規則的名稱。	字串 （必要）
ipMask	字串，包含規則之 CIDR 表示法中的 IP 位址範圍。	字串 （必要）
目標	此規則所擷取的要求目標。	'all' 'deviceApi' 'serviceApi'

Microsoft.Devices/provisioningServices

名字	描述	價值
etag	Etag 欄位 不需要。 如果在響應主體中提供，則也必須根據一般 ETag 慣例提供它作為標頭。	字串
位置	資源位置。	字串 （必要）
名字	資源名稱	字串 （必要）
性能	布建服務的服務特定屬性	IotDpsPropertiesDescription （必要）
sku	布建服務的Sku資訊。	IotDpsSkuInfo （必要）
標籤	資源標籤	標記名稱和值的字典。 請參閱範本中的 標籤

ResourceTags

名字	描述	價值

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

名字	描述	價值
keyName	索引鍵的名稱。	字串 （必要）
primaryKey	主要 SAS 金鑰值。	字串
權利	此金鑰擁有的許可權。	'DeviceConnect' 'EnrollmentRead' 'EnrollmentWrite' 'RegistrationStatusRead' 'RegistrationStatusWrite' 'ServiceConfig' （必要）
secondaryKey	次要 SAS 金鑰值。	字串

快速入門範例

下列快速入門範例會部署此資源類型。

Bicep 檔案	描述
建立IoT中樞裝置布建服務	此範本可讓您建立IoT中樞和IoT中樞裝置布建服務，並將這兩個服務連結在一起。

ARM 樣本資源定義

provisioningServices 資源類型可以使用目標作業來部署：

• 資源群組 - 請參閱 資源群組部署命令

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.Devices/provisioningServices 資源，請將下列 JSON 新增至範本。

{
  "type": "Microsoft.Devices/provisioningServices",
  "apiVersion": "2020-01-01",
  "name": "string",
  "etag": "string",
  "location": "string",
  "properties": {
    "allocationPolicy": "string",
    "authorizationPolicies": [
      {
        "keyName": "string",
        "primaryKey": "string",
        "rights": "string",
        "secondaryKey": "string"
      }
    ],
    "iotHubs": [
      {
        "allocationWeight": "int",
        "applyAllocationPolicy": "bool",
        "connectionString": "string",
        "location": "string"
      }
    ],
    "ipFilterRules": [
      {
        "action": "string",
        "filterName": "string",
        "ipMask": "string",
        "target": "string"
      }
    ],
    "provisioningState": "string",
    "state": "string"
  },
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

屬性值

IotDpsPropertiesDescription

名字	描述	價值
allocationPolicy	此布建服務要使用的配置原則。	'GeoLatency' 'Hashed' 'Static'
authorizationPolicies	布建服務的授權金鑰清單。	SharedAccessSignatureAuthorizationRuleAccessRightsDescription[]
iotHubs	與此布建服務相關聯的IoT中樞清單。	IotHubDefinitionDescription[]
ipFilterRules	IP 篩選規則。	IpFilterRule[]
provisioningState	布建服務的ARM布建狀態。	字串
州	布建服務的目前狀態。	'啟用' 'ActivationFailed' 'Active' 'Deleted' '刪除' 'DeletionFailed' 'FailingOver' 'FailoverFailed' '繼續' 'Suspended' 'Suspending' 'Transitioning'

IotDpsSkuInfo

名字	描述	價值
能力	要布建的單位數目	int
名字	Sku 名稱。	'S1'

IotHubDefinitionDescription

名字	描述	價值
allocationWeight	要套用指定 iot h 的權數。	int
applyAllocationPolicy	用於套用allocationPolicy或不適用於指定的iot中樞的旗標。	bool
connectionString	連接字串 og ioT 中樞。	字串 （必要）
位置	IoT 中樞的ARM區域。	字串 （必要）

IpFilterRule

名字	描述	價值
行動	此規則所擷取要求所需的動作。	'Accept' '拒絕' （必要）
filterName	IP 篩選規則的名稱。	字串 （必要）
ipMask	字串，包含規則之 CIDR 表示法中的 IP 位址範圍。	字串 （必要）
目標	此規則所擷取的要求目標。	'all' 'deviceApi' 'serviceApi'

Microsoft.Devices/provisioningServices

名字	描述	價值
apiVersion	API 版本	'2020-01-01'
etag	Etag 欄位 不需要。 如果在響應主體中提供，則也必須根據一般 ETag 慣例提供它作為標頭。	字串
位置	資源位置。	字串 （必要）
名字	資源名稱	字串 （必要）
性能	布建服務的服務特定屬性	IotDpsPropertiesDescription （必要）
sku	布建服務的Sku資訊。	IotDpsSkuInfo （必要）
標籤	資源標籤	標記名稱和值的字典。 請參閱範本中的 標籤
類型	資源類型	'Microsoft.Devices/provisioningServices'

ResourceTags

名字	描述	價值

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

名字	描述	價值
keyName	索引鍵的名稱。	字串 （必要）
primaryKey	主要 SAS 金鑰值。	字串
權利	此金鑰擁有的許可權。	'DeviceConnect' 'EnrollmentRead' 'EnrollmentWrite' 'RegistrationStatusRead' 'RegistrationStatusWrite' 'ServiceConfig' （必要）
secondaryKey	次要 SAS 金鑰值。	字串

快速入門範本

下列快速入門範本會部署此資源類型。

範本	描述
建立 IOT 中樞和 Ubuntu 邊緣模擬器	此範本會建立 IOT 中樞和虛擬機 Ubuntu 邊緣模擬器。
建立IoT中樞裝置布建服務	此範本可讓您建立IoT中樞和IoT中樞裝置布建服務，並將這兩個服務連結在一起。

Terraform （AzAPI 提供者） 資源定義

provisioningServices 資源類型可以使用目標作業來部署：

• 資源群組

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.Devices/provisioningServices 資源，請將下列 Terraform 新增至範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Devices/provisioningServices@2020-01-01"
  name = "string"
  etag = "string"
  location = "string"
  body = jsonencode({
    properties = {
      allocationPolicy = "string"
      authorizationPolicies = [
        {
          keyName = "string"
          primaryKey = "string"
          rights = "string"
          secondaryKey = "string"
        }
      ]
      iotHubs = [
        {
          allocationWeight = int
          applyAllocationPolicy = bool
          connectionString = "string"
          location = "string"
        }
      ]
      ipFilterRules = [
        {
          action = "string"
          filterName = "string"
          ipMask = "string"
          target = "string"
        }
      ]
      provisioningState = "string"
      state = "string"
    }
  })
  sku = {
    capacity = int
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
}

屬性值

IotDpsPropertiesDescription

名字	描述	價值
allocationPolicy	此布建服務要使用的配置原則。	'GeoLatency' 'Hashed' 'Static'
authorizationPolicies	布建服務的授權金鑰清單。	SharedAccessSignatureAuthorizationRuleAccessRightsDescription[]
iotHubs	與此布建服務相關聯的IoT中樞清單。	IotHubDefinitionDescription[]
ipFilterRules	IP 篩選規則。	IpFilterRule[]
provisioningState	布建服務的ARM布建狀態。	字串
州	布建服務的目前狀態。	'啟用' 'ActivationFailed' 'Active' 'Deleted' '刪除' 'DeletionFailed' 'FailingOver' 'FailoverFailed' '繼續' 'Suspended' 'Suspending' 'Transitioning'

IotDpsSkuInfo

名字	描述	價值
能力	要布建的單位數目	int
名字	Sku 名稱。	'S1'

IotHubDefinitionDescription

名字	描述	價值
allocationWeight	要套用指定 iot h 的權數。	int
applyAllocationPolicy	用於套用allocationPolicy或不適用於指定的iot中樞的旗標。	bool
connectionString	連接字串 og ioT 中樞。	字串 （必要）
位置	IoT 中樞的ARM區域。	字串 （必要）

IpFilterRule

名字	描述	價值
行動	此規則所擷取要求所需的動作。	'Accept' '拒絕' （必要）
filterName	IP 篩選規則的名稱。	字串 （必要）
ipMask	字串，包含規則之 CIDR 表示法中的 IP 位址範圍。	字串 （必要）
目標	此規則所擷取的要求目標。	'all' 'deviceApi' 'serviceApi'

Microsoft.Devices/provisioningServices

名字	描述	價值
etag	Etag 欄位 不需要。 如果在響應主體中提供，則也必須根據一般 ETag 慣例提供它作為標頭。	字串
位置	資源位置。	字串 （必要）
名字	資源名稱	字串 （必要）
性能	布建服務的服務特定屬性	IotDpsPropertiesDescription （必要）
sku	布建服務的Sku資訊。	IotDpsSkuInfo （必要）
標籤	資源標籤	標記名稱和值的字典。
類型	資源類型	“Microsoft.Devices/provisioningServices@2020-01-01”

ResourceTags

名字	描述	價值

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

名字	描述	價值
keyName	索引鍵的名稱。	字串 （必要）
primaryKey	主要 SAS 金鑰值。	字串
權利	此金鑰擁有的許可權。	'DeviceConnect' 'EnrollmentRead' 'EnrollmentWrite' 'RegistrationStatusRead' 'RegistrationStatusWrite' 'ServiceConfig' （必要）
secondaryKey	次要 SAS 金鑰值。	字串