共用方式為


Microsoft.Devices provisioningServices

Bicep 資源定義

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

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

資源格式

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

resource symbolicname 'Microsoft.Devices/provisioningServices@2023-03-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    name: 'S1'
  }
  etag: 'string'
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    allocationPolicy: 'string'
    authorizationPolicies: [
      {
        keyName: 'string'
        primaryKey: 'string'
        rights: 'string'
        secondaryKey: 'string'
        keyName: 'string'
        primaryKey: 'string'
        rights: 'string'
        secondaryKey: 'string'
      }
    ]
    enableDataResidency: bool
    iotHubs: [
      {
        allocationWeight: int
        applyAllocationPolicy: bool
        connectionString: 'string'
        location: 'string'
      }
    ]
    ipFilterRules: [
      {
        action: 'string'
        filterName: 'string'
        ipMask: 'string'
        target: 'string'
      }
    ]
    portalOperationsHostName: 'string'
    privateEndpointConnections: [
      {
        properties: {
          privateEndpoint: {}
          privateLinkServiceConnectionState: {
            actionsRequired: 'string'
            description: 'string'
            status: 'string'
          }
        }
      }
    ]
    provisioningState: 'string'
    publicNetworkAccess: 'string'
    state: 'string'
  }
  resourcegroup: 'string'
  subscriptionid: 'string'
}

屬性值

provisioningServices

名稱 描述
NAME 資源名稱 字串 (必要)

字元限制:3-64

合法字元:
英數字元和連字號。

以英數字元結尾。
location 資源位置。 字串 (必要)
tags 資源標籤。 標記名稱和值的字典。 請參閱 範本中的標記
sku 布建服務的 SKU 資訊。 需要 IotDpsSkuInfo ()
etag 不需要 Etag 欄位。 如果在回應本文中提供,也必須依一般 ETag 慣例提供它做為標頭。 字串
身分識別 布建服務的受控識別。 ManagedServiceIdentity
properties 布建服務的服務特定屬性 IotDpsPropertiesDescription (必要)
resourcegroup 資源的資源群組。 字串
subscriptionid 資源的訂用帳戶標識碼。 字串

ManagedServiceIdentity

名稱 描述
類型 (允許 SystemAssigned 和 UserAssigned 類型的受控服務識別類型) 。 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned' (必要)
userAssignedIdentities 與資源相關聯的使用者指派身分識別集。 userAssignedIdentities 字典索引鍵的格式為 ARM 資源標識符:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}。 字典值可以是要求中 () 的空白物件 {} 。 UserAssignedIdentities

UserAssignedIdentities

名稱 描述
{自定義屬性} UserAssignedIdentity

UserAssignedIdentity

此物件不包含部署期間要設定的任何屬性。 所有屬性都是 ReadOnly。

IotDpsPropertiesDescription

名稱 描述
allocationPolicy 此布建服務要使用的配置原則。 'GeoLatency'
'Hashed'
'Static'
authorizationPolicies 布建服務的授權金鑰清單。 SharedAccessSignatureAuthorizationRuleAccessRightsDe...[]
enableDataResidency 選擇性。
指出 DPS 實例是否已啟用 Data Residency,移除跨異地配對災害復原。
bool
iotHubs 與此布建服務相關聯的IoT中樞清單。 IotHubDefinitionDescription[]
ipFilterRules IP 篩選規則。 IpFilterRule[]
portalOperationsHostName 啟用此布建服務的 CORS 入口網站端點。 字串
privateEndpointConnections 在此IotHub上建立的私人端點連線 PrivateEndpointConnection[]
provisioningState 布建服務的ARM布建狀態。 字串
publicNetworkAccess 是否允許來自公用網路的要求 'Disabled'
'Enabled'
狀態 布建服務的目前狀態。 '啟用'
'ActivationFailed'
'Active'
'Deleted'
'刪除'
'DeletionFailed'
'FailingOver'
'FailoverFailed'
'Resuming'
'Suspended'
'Suspending'
'Transitioning'

SharedAccessSignatureAuthorizationRuleAccessRightsDe...

名稱 描述
keyName 金鑰的名稱。 需要字串 ()
primaryKey 主要 SAS 金鑰值。 字串
權限 此金鑰擁有的許可權。 'DeviceConnect'
'EnrollmentRead'
'EnrollmentWrite'
'RegistrationStatusRead'
'RegistrationStatusWrite'
需要 『ServiceConfig』 ()
secondaryKey 次要 SAS 金鑰值。 字串
keyName 金鑰的名稱。 需要字串 ()
primaryKey 主要 SAS 金鑰值。 字串
權限 此金鑰擁有的許可權。 'DeviceConnect'
'EnrollmentRead'
'EnrollmentWrite'
'RegistrationStatusRead'
'RegistrationStatusWrite'
需要 『ServiceConfig』 ()
secondaryKey 次要 SAS 金鑰值。 字串

IotHubDefinitionDescription

名稱 描述
allocationWeight 要套用至指定 iot h 的權數。 int
applyAllocationPolicy 旗標,用於套用allocationPolicy或不適用於指定的iot中樞。 bool
connectionString IoT 中樞的連接字串。 需要字串 ()
location IoT 中樞的ARM區域。 需要字串 ()

IpFilterRule

名稱 描述
動作 此規則所擷取之要求所需的動作。 'Accept'
需要 『Reject』 ()
filterName IP 篩選規則的名稱。 需要字串 ()
ipMask 字串,包含規則 CIDR 表示法中的IP位址範圍。 需要字串 ()
目標 此規則所擷取的要求目標。 'all'
'deviceApi'
'serviceApi'

PrivateEndpointConnection

名稱 描述
properties 私人端點連線的屬性 PrivateEndpointConnectionProperties (必要)

PrivateEndpointConnectionProperties

名稱 描述
privateEndpoint 私人端點連線的私人端點屬性 PrivateEndpoint
privateLinkServiceConnectionState 私人端點連線的目前狀態 PrivateLinkServiceConnectionState (必要)

PrivateEndpoint

此物件不包含部署期間要設定的任何屬性。 所有屬性都是 ReadOnly。

PrivateLinkServiceConnectionState

名稱 描述
actionsRequired 私人端點連線所需的動作 字串
description 私人端點連線目前狀態的描述 字串 (必要)
status 私人端點連線的狀態 「已核准」
'Disconnected'
'Pending'
必要) 「已拒絕」 (

IotDpsSkuInfo

名稱 描述
處理能力 要布建的單位數目 int
NAME Sku 名稱。 'S1'

快速入門範本

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

範本 描述
建立 IOT 中樞和 Ubuntu 邊緣模擬器

部署至 Azure
此範本會建立 IOT 中樞和虛擬機 Ubuntu 邊緣模擬器。
建立 IoT 中樞 裝置布建服務

部署至 Azure
此範本可讓您建立IoT中樞和 IoT 中樞裝置布建服務,並將兩個服務連結在一起。

ARM 範本資源定義

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

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

資源格式

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

{
  "type": "Microsoft.Devices/provisioningServices",
  "apiVersion": "2023-03-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "name": "S1"
  },
  "etag": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "allocationPolicy": "string",
    "authorizationPolicies": [
      {
        "keyName": "string",
        "primaryKey": "string",
        "rights": "string",
        "secondaryKey": "string",
        "keyName": "string",
        "primaryKey": "string",
        "rights": "string",
        "secondaryKey": "string"
      }
    ],
    "enableDataResidency": "bool",
    "iotHubs": [
      {
        "allocationWeight": "int",
        "applyAllocationPolicy": "bool",
        "connectionString": "string",
        "location": "string"
      }
    ],
    "ipFilterRules": [
      {
        "action": "string",
        "filterName": "string",
        "ipMask": "string",
        "target": "string"
      }
    ],
    "portalOperationsHostName": "string",
    "privateEndpointConnections": [
      {
        "properties": {
          "privateEndpoint": {},
          "privateLinkServiceConnectionState": {
            "actionsRequired": "string",
            "description": "string",
            "status": "string"
          }
        }
      }
    ],
    "provisioningState": "string",
    "publicNetworkAccess": "string",
    "state": "string"
  },
  "resourcegroup": "string",
  "subscriptionid": "string"
}

屬性值

provisioningServices

名稱 描述
類型 資源類型 'Microsoft.Devices/provisioningServices'
apiVersion 資源 API 版本 '2023-03-01-preview'
NAME 資源名稱 字串 (必要)

字元限制:3-64

合法字元:
英數字元和連字號。

以英數字元結尾。
location 資源位置。 字串 (必要)
tags 資源標籤。 標記名稱和值的字典。 請參閱 範本中的標記
sku 布建服務的 SKU 資訊。 需要 IotDpsSkuInfo ()
etag 不需要 Etag 欄位。 如果在回應本文中提供,也必須依一般 ETag 慣例提供它做為標頭。 字串
身分識別 布建服務的受控識別。 ManagedServiceIdentity
properties 布建服務的服務特定屬性 IotDpsPropertiesDescription (必要)
resourcegroup 資源的資源群組。 字串
subscriptionid 資源的訂用帳戶標識碼。 字串

ManagedServiceIdentity

名稱 描述
類型 (允許 SystemAssigned 和 UserAssigned 類型的受控服務識別類型) 。 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned' (必要)
userAssignedIdentities 與資源相關聯的使用者指派身分識別集。 userAssignedIdentities 字典索引鍵的格式為 ARM 資源標識符:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}。 字典值可以是要求中 () 的空白物件 {} 。 UserAssignedIdentities

UserAssignedIdentities

名稱 描述
{自定義屬性} UserAssignedIdentity

UserAssignedIdentity

此物件不包含部署期間要設定的任何屬性。 所有屬性都是 ReadOnly。

IotDpsPropertiesDescription

名稱 描述
allocationPolicy 此布建服務要使用的配置原則。 'GeoLatency'
'Hashed'
'Static'
authorizationPolicies 布建服務的授權金鑰清單。 SharedAccessSignatureAuthorizationRuleAccessRightsDe...[]
enableDataResidency 選擇性。
指出 DPS 實例是否已啟用 Data Residency,並移除跨異地配對災害復原。
bool
iotHubs 與此布建服務相關聯的IoT中樞清單。 IotHubDefinitionDescription[]
ipFilterRules IP 篩選規則。 IpFilterRule[]
portalOperationsHostName 啟用此布建服務的 CORS 入口網站端點。 字串
privateEndpointConnections 在此IotHub上建立的私人端點連線 PrivateEndpointConnection[]
provisioningState 布建服務的ARM布建狀態。 字串
publicNetworkAccess 是否允許來自公用網路的要求 'Disabled'
'Enabled'
狀態 布建服務的目前狀態。 '啟用'
'ActivationFailed'
'Active'
'Deleted'
'刪除'
'DeletionFailed'
'FailingOver'
'FailoverFailed'
'Resuming'
'Suspended'
'Suspending'
'Transitioning'

SharedAccessSignatureAuthorizationRuleAccessRightsDe...

名稱 描述
keyName 金鑰的名稱。 字串 (必要)
primaryKey 主要 SAS 金鑰值。 字串
權限 此金鑰擁有的許可權。 'DeviceConnect'
'EnrollmentRead'
'EnrollmentWrite'
'RegistrationStatusRead'
'RegistrationStatusWrite'
需要 『ServiceConfig』 ()
secondaryKey 次要 SAS 金鑰值。 字串
keyName 金鑰的名稱。 需要字串 ()
primaryKey 主要 SAS 金鑰值。 字串
權限 此金鑰擁有的許可權。 'DeviceConnect'
'EnrollmentRead'
'EnrollmentWrite'
'RegistrationStatusRead'
'RegistrationStatusWrite'
需要 『ServiceConfig』 ()
secondaryKey 次要 SAS 金鑰值。 字串

IotHubDefinitionDescription

名稱 描述
allocationWeight 要套用至指定 iot h 的權數。 int
applyAllocationPolicy 旗標,用於套用allocationPolicy或不適用於指定的iot中樞。 bool
connectionString IoT 中樞的連接字串。 需要字串 ()
location IoT 中樞的ARM區域。 需要字串 ()

IpFilterRule

名稱 描述
動作 此規則所擷取之要求所需的動作。 'Accept'
需要 『Reject』 ()
filterName IP 篩選規則的名稱。 需要字串 ()
ipMask 字串,包含規則 CIDR 表示法中的IP位址範圍。 需要字串 ()
目標 此規則所擷取的要求目標。 'all'
'deviceApi'
'serviceApi'

PrivateEndpointConnection

名稱 描述
properties 私人端點連線的屬性 PrivateEndpointConnectionProperties (必要)

PrivateEndpointConnectionProperties

名稱 描述
privateEndpoint 私人端點連線的私人端點屬性 PrivateEndpoint
privateLinkServiceConnectionState 私人端點連線的目前狀態 PrivateLinkServiceConnectionState (必要)

PrivateEndpoint

此物件不包含部署期間要設定的任何屬性。 所有屬性都是 ReadOnly。

PrivateLinkServiceConnectionState

名稱 描述
actionsRequired 私人端點連線所需的動作 字串
description 私人端點連線目前狀態的描述 需要字串 ()
status 私人端點連線的狀態 'Approved'
'Disconnected'
'Pending'
必要) 「已拒絕」 (

IotDpsSkuInfo

名稱 描述
處理能力 要布建的單位數目 int
NAME Sku 名稱。 'S1'

快速入門範本

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

範本 描述
建立 IOT 中樞和 Ubuntu 邊緣模擬器

部署至 Azure
此範本會建立 IOT 中樞和虛擬機 Ubuntu 邊緣模擬器。
建立 IoT 中樞 裝置布建服務

部署至 Azure
此範本可讓您建立IoT中樞和 IoT 中樞裝置布建服務,並將這兩個服務連結在一起。

Terraform (AzAPI 提供者) 資源定義

provisioningServices 資源類型可以使用目標作業進行部署:

  • 資源群組

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

資源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Devices/provisioningServices@2023-03-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      allocationPolicy = "string"
      authorizationPolicies = [
        {
          keyName = "string"
          primaryKey = "string"
          rights = "string"
          secondaryKey = "string"
          keyName = "string"
          primaryKey = "string"
          rights = "string"
          secondaryKey = "string"
        }
      ]
      enableDataResidency = bool
      iotHubs = [
        {
          allocationWeight = int
          applyAllocationPolicy = bool
          connectionString = "string"
          location = "string"
        }
      ]
      ipFilterRules = [
        {
          action = "string"
          filterName = "string"
          ipMask = "string"
          target = "string"
        }
      ]
      portalOperationsHostName = "string"
      privateEndpointConnections = [
        {
          properties = {
            privateEndpoint = {}
            privateLinkServiceConnectionState = {
              actionsRequired = "string"
              description = "string"
              status = "string"
            }
          }
        }
      ]
      provisioningState = "string"
      publicNetworkAccess = "string"
      state = "string"
    }
    resourcegroup = "string"
    subscriptionid = "string"
    sku = {
      capacity = int
      name = "S1"
    }
    etag = "string"
  })
}

屬性值

provisioningServices

名稱 描述
類型 資源類型 “Microsoft.Devices/provisioningServices@2023-03-01-preview”
NAME 資源名稱 需要字串 ()

字元限制:3-64

合法字元:
英數字元和連字號。

以英數字元結尾。
location 資源位置。 需要字串 ()
parent_id 若要部署至資源群組,請使用該資源群組的標識碼。 需要字串 ()
tags 資源標籤。 標記名稱和值的字典。
sku 布建服務的 SKU 資訊。 需要 IotDpsSkuInfo ()
etag 不需要 Etag 欄位。 如果在回應本文中提供,則也必須根據一般 ETag 慣例,以標頭的形式提供。 字串
身分識別 布建服務的受控識別。 ManagedServiceIdentity
properties 布建服務的服務特定屬性 需要 IotDpsPropertiesDescription ()
resourcegroup 資源的資源群組。 字串
subscriptionid 資源的訂用帳戶標識碼。 字串

ManagedServiceIdentity

名稱 描述
類型 (允許 SystemAssigned 和 UserAssigned 類型的受控服務識別類型) 。 “SystemAssigned”
“SystemAssigned,UserAssigned”
“UserAssigned” (必要)
identity_ids 與資源相關聯的使用者指派身分識別集。 userAssignedIdentities 字典索引鍵的格式為 ARM 資源標識符:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}。 字典值可以是要求中 ({}) 的空白物件。 使用者身分識別標識碼的陣列。

UserAssignedIdentities

名稱 描述
{自定義屬性} UserAssignedIdentity

UserAssignedIdentity

此物件不包含部署期間要設定的任何屬性。 所有屬性都是 ReadOnly。

IotDpsPropertiesDescription

名稱 描述
allocationPolicy 此布建服務要使用的配置原則。 “GeoLatency”
“Hashed”
“Static”
authorizationPolicies 布建服務的授權金鑰清單。 SharedAccessSignatureAuthorizationRuleAccessRightsDe...[]
enableDataResidency 選擇性。
指出 DPS 實例是否已啟用 Data Residency,移除跨異地配對災害復原。
bool
iotHubs 與此布建服務相關聯的IoT中樞清單。 IotHubDefinitionDescription[]
ipFilterRules IP 篩選規則。 IpFilterRule[]
portalOperationsHostName 啟用此布建服務的 CORS 入口網站端點。 字串
privateEndpointConnections 在此IotHub上建立的私人端點連線 PrivateEndpointConnection[]
provisioningState 布建服務的ARM布建狀態。 字串
publicNetworkAccess 是否允許來自公用網路的要求 “Disabled”
“Enabled”
狀態 布建服務的目前狀態。 「啟動」
“ActivationFailed”
“Active”
“Deleted”
“刪除”
“DeletionFailed”
“故障轉移”
“FailoverFailed”
“繼續”
“Suspended”
“Suspending”
“轉換”

SharedAccessSignatureAuthorizationRuleAccessRightsDe...

名稱 描述
keyName 金鑰的名稱。 字串 (必要)
primaryKey 主要 SAS 金鑰值。 字串
權限 此金鑰擁有的許可權。 “DeviceConnect”
“EnrollmentRead”
“EnrollmentWrite”
“RegistrationStatusRead”
“RegistrationStatusWrite”
“ServiceConfig” (必要)
secondaryKey 次要 SAS 金鑰值。 字串
keyName 金鑰的名稱。 字串 (必要)
primaryKey 主要 SAS 金鑰值。 字串
權限 此金鑰擁有的許可權。 “DeviceConnect”
“EnrollmentRead”
“EnrollmentWrite”
“RegistrationStatusRead”
“RegistrationStatusWrite”
“ServiceConfig” (必要)
secondaryKey 次要 SAS 金鑰值。 字串

IotHubDefinitionDescription

名稱 描述
allocationWeight 要套用至指定 iot h 的權數。 int
applyAllocationPolicy 套用allocationPolicy或不適用於指定的iot中樞的旗標。 bool
connectionString IoT 中樞的連接字串。 字串 (必要)
location IoT 中樞的ARM區域。 字串 (必要)

IpFilterRule

名稱 描述
動作 此規則所擷取之要求的所需動作。 “Accept”
必要的「拒絕」 ()
filterName IP 篩選規則的名稱。 字串 (必要)
ipMask 字串,包含規則 CIDR 表示法中的IP位址範圍。 字串 (必要)
目標 此規則所擷取的要求目標。 “all”
“deviceApi”
“serviceApi”

PrivateEndpointConnection

名稱 描述
properties 私人端點連線的屬性 PrivateEndpointConnectionProperties (必要)

PrivateEndpointConnectionProperties

名稱 描述
privateEndpoint 私人端點連線的私人端點屬性 PrivateEndpoint
privateLinkServiceConnectionState 私人端點連線的目前狀態 PrivateLinkServiceConnectionState (必要)

PrivateEndpoint

此物件不包含部署期間要設定的任何屬性。 所有屬性都是 ReadOnly。

PrivateLinkServiceConnectionState

名稱 描述
actionsRequired 私人端點連線所需的動作 字串
description 私人端點連線目前狀態的描述 字串 (必要)
status 私人端點連線的狀態 「已核准」
「已中斷連線」
“Pending”
「已拒絕」 (必要)

IotDpsSkuInfo

名稱 描述
處理能力 要布建的單位數目 int
NAME Sku 名稱。 “S1”