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 リソース名 string (必須)

文字数制限: 3 から 64

有効な文字:
英数字とハイフン。

末尾には英数文字を使用します。
location リソースの場所。 string (必須)
tags リソース タグ。 タグ名と値のディクショナリ。 「テンプレートのタグ」を参照してください
sku プロビジョニング サービスの SKU 情報。 IotDpsSkuInfo (必須)
etag Etag フィールドは必須 ではありません 。 応答本文で指定する場合は、通常の ETag 規則に従ってヘッダーとしても指定する必要があります。 string
identity プロビジョニング サービスのマネージド ID。 ManagedServiceIdentity
properties プロビジョニング サービスのサービス固有のプロパティ IotDpsPropertiesDescription (必須)
resourcegroup リソースのリソース グループ。 string
subscriptionid リソースのサブスクリプション ID。 string

ManagedServiceIdentity

名前 説明
type マネージド サービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned' (必須)
userAssignedIdentities リソースに関連付けられているユーザー割り当て ID のセット。 userAssignedIdentities ディクショナリ キーは、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} という形式の ARM リソース ID になります。 ディクショナリ値には、要求で空のオブジェクト ({}) を指定できます。 UserAssignedIdentities

UserAssignedIdentities

名前 説明
{カスタマイズされたプロパティ} UserAssignedIdentity

UserAssignedIdentity

このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。

IotDpsPropertiesDescription

名前 説明
allocationPolicy このプロビジョニング サービスで使用される割り当てポリシー。 'GeoLatency'
'Hashed'
'Static'
authorizationPolicies プロビジョニング サービスの承認キーの一覧。 SharedAccessSignatureAuthorizationRuleAccessRightsDe...[]
enableDataResidency 省略可能。
DPS インスタンスがData Residency有効になっているかどうかを示し、geo ペア間のディザスター リカバリーを削除します。
[bool]
iotHubs このプロビジョニング サービスに関連付けられている IoT ハブの一覧。 IotHubDefinitionDescription[]
ipFilterRules IP フィルター規則。 IpFilterRule[]
portalOperationsHostName このプロビジョニング サービスの CORS を有効にするポータル エンドポイント。 string
privateEndpointConnections この IotHub で作成されたプライベート エンドポイント接続 PrivateEndpointConnection[]
provisioningState プロビジョニング サービスの ARM プロビジョニング状態。 string
publicNetworkAccess パブリック ネットワークからの要求を許可するかどうか 'Disabled'
'Enabled'
state プロビジョニング サービスの現在の状態。 'アクティブ化中'
'ActivationFailed'
'Active'
'Deleted'
'削除中'
'DeletionFailed'
'FailingOver'
'FailoverFailed'
'再開中'
'Suspended'
'Suspending'
'Transitioning'

SharedAccessSignatureAuthorizationRuleAccessRightsDe...

名前 説明
keyName キーの名前。 string (必須)
primaryKey プライマリ SAS キーの値。 string
権限 このキーに含まれる権限。 'DeviceConnect'
'EnrollmentRead'
'EnrollmentWrite'
'RegistrationStatusRead'
'RegistrationStatusWrite'
'ServiceConfig' (必須)
secondaryKey セカンダリ SAS キー値。 string
keyName キーの名前。 string (必須)
primaryKey プライマリ SAS キーの値。 string
権限 このキーに含まれる権限。 'DeviceConnect'
'EnrollmentRead'
'EnrollmentWrite'
'RegistrationStatusRead'
'RegistrationStatusWrite'
'ServiceConfig' (必須)
secondaryKey セカンダリ SAS キー値。 string

IotHubDefinitionDescription

名前 説明
allocationWeight 特定の iot h に適用する重み。 INT
applyAllocationPolicy 特定の iot ハブに allocationPolicy を適用する場合は フラグ。 [bool]
connectionString IoT ハブの接続文字列。 string (必須)
location IoT ハブの ARM リージョン。 string (必須)

IpFilterRule

名前 説明
action このルールによってキャプチャされた要求に対して必要なアクション。 'Accept'
'Reject' (必須)
filterName IP フィルター規則の名前。 string (必須)
ipMask 規則の IP アドレス範囲を CIDR 表記で含む文字列。 string (必須)
ターゲット (target) このルールによってキャプチャされた要求のターゲット。 'all'
'deviceApi'
'serviceApi'

PrivateEndpointConnection

名前 説明
properties プライベート エンドポイント接続のプロパティ PrivateEndpointConnectionProperties (必須)

PrivateEndpointConnectionProperties

名前 説明
privateEndpoint プライベート エンドポイント接続のプライベート エンドポイント プロパティ PrivateEndpoint
privateLinkServiceConnectionState プライベート エンドポイント接続の現在の状態 PrivateLinkServiceConnectionState (必須)

PrivateEndpoint

このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。

PrivateLinkServiceConnectionState

名前 説明
actionsRequired プライベート エンドポイント接続に必要なアクション string
description プライベート エンドポイント接続の現在の状態の説明 string (必須)
status プライベート エンドポイント接続の状態 '承認済み'
'Disconnected'
'保留中'
'Rejected' (必須)

IotDpsSkuInfo

名前 説明
capacity プロビジョニングするユニットの数 INT
name SKU 名。 'S1'

クイック スタート テンプレート

次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。

Template 説明
IOT Hub と Ubuntu エッジ シミュレーターを作成する

Azure にデプロイする
このテンプレートでは、IOT ハブと仮想マシンの Ubuntu エッジ シミュレーターを作成します。
IoT Hub Device Provisioning Service を作成する

Azure にデプロイする
このテンプレートを使用すると、IoT ハブと IoT Hub Device Provisioning Service を作成し、2 つのサービスをリンクできます。

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

名前 説明
type リソースの種類 'Microsoft.Devices/provisioningServices'
apiVersion リソース API のバージョン '2023-03-01-preview'
name リソース名 string (必須)

文字数制限: 3 から 64

有効な文字:
英数字とハイフン。

末尾には英数文字を使用します。
location リソースの場所。 string (必須)
tags リソース タグ。 タグ名と値のディクショナリ。 「テンプレートのタグ」を参照してください
sku プロビジョニング サービスの SKU 情報。 IotDpsSkuInfo (必須)
etag Etag フィールドは必須 ではありません 。 応答本文で指定する場合は、通常の ETag 規則に従ってヘッダーとしても指定する必要があります。 string
identity プロビジョニング サービスのマネージド ID。 ManagedServiceIdentity
properties プロビジョニング サービスのサービス固有のプロパティ IotDpsPropertiesDescription (必須)
resourcegroup リソースのリソース グループ。 string
subscriptionid リソースのサブスクリプション ID。 string

ManagedServiceIdentity

名前 説明
type マネージド サービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned' (必須)
userAssignedIdentities リソースに関連付けられているユーザー割り当て ID のセット。 userAssignedIdentities ディクショナリ キーは、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} という形式の ARM リソース ID になります。 ディクショナリ値は、要求で空のオブジェクト ({}) にすることができます。 UserAssignedIdentities

UserAssignedIdentities

名前 説明
{カスタマイズされたプロパティ} UserAssignedIdentity

UserAssignedIdentity

このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。

IotDpsPropertiesDescription

名前 説明
allocationPolicy このプロビジョニング サービスで使用される割り当てポリシー。 'GeoLatency'
'Hashed'
'Static'
authorizationPolicies プロビジョニング サービスの承認キーの一覧。 SharedAccessSignatureAuthorizationRuleAccessRightsDe...[]
enableDataResidency 省略可能。
DPS インスタンスがData Residency有効になっているかどうかを示し、geo ペア間のディザスター リカバリーを削除します。
[bool]
iotHubs このプロビジョニング サービスに関連付けられている IoT ハブの一覧。 IotHubDefinitionDescription[]
ipFilterRules IP フィルター規則。 IpFilterRule[]
portalOperationsHostName このプロビジョニング サービスの CORS を有効にするポータル エンドポイント。 string
privateEndpointConnections この IotHub で作成されたプライベート エンドポイント接続 PrivateEndpointConnection[]
provisioningState プロビジョニング サービスの ARM プロビジョニング状態。 string
publicNetworkAccess パブリック ネットワークからの要求が許可されるかどうか 'Disabled'
'Enabled'
state プロビジョニング サービスの現在の状態。 'アクティブ化中'
'ActivationFailed'
'Active'
'Deleted'
'削除中'
'DeletionFailed'
'FailingOver'
'FailoverFailed'
'再開'
'Suspended'
'Suspending'
'Transitioning'

SharedAccessSignatureAuthorizationRuleAccessRightsDe...

名前 説明
keyName キーの名前。 string (必須)
primaryKey プライマリ SAS キー値。 string
権限 このキーに与える権限。 'DeviceConnect'
'EnrollmentRead'
'EnrollmentWrite'
'RegistrationStatusRead'
'RegistrationStatusWrite'
'ServiceConfig' (必須)
secondaryKey セカンダリ SAS キー値。 string
keyName キーの名前。 string (必須)
primaryKey プライマリ SAS キー値。 string
権限 このキーに与える権限。 'DeviceConnect'
'EnrollmentRead'
'EnrollmentWrite'
'RegistrationStatusRead'
'RegistrationStatusWrite'
'ServiceConfig' (必須)
secondaryKey セカンダリ SAS キー値。 string

IotHubDefinitionDescription

名前 説明
allocationWeight 特定の iot h に適用する重み。 INT
applyAllocationPolicy 指定された iot ハブに allocationPolicy を適用するためのフラグ。 [bool]
connectionString IoT ハブの接続文字列。 string (必須)
location IoT ハブの ARM リージョン。 string (必須)

IpFilterRule

名前 説明
action このルールによってキャプチャされた要求に対して必要なアクション。 'Accept'
'Reject' (必須)
filterName IP フィルター規則の名前。 string (必須)
ipMask ルールの CIDR 表記の IP アドレス範囲を含む文字列。 string (必須)
ターゲット (target) このルールによってキャプチャされた要求のターゲット。 'all'
'deviceApi'
'serviceApi'

PrivateEndpointConnection

名前 説明
properties プライベート エンドポイント接続のプロパティ PrivateEndpointConnectionProperties (必須)

PrivateEndpointConnectionProperties

名前 説明
privateEndpoint プライベート エンドポイント接続のプライベート エンドポイント プロパティ PrivateEndpoint
privateLinkServiceConnectionState プライベート エンドポイント接続の現在の状態 PrivateLinkServiceConnectionState (必須)

PrivateEndpoint

このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。

PrivateLinkServiceConnectionState

名前 説明
actionsRequired プライベート エンドポイント接続に必要なアクション string
description プライベート エンドポイント接続の現在の状態の説明 string (必須)
status プライベート エンドポイント接続の状態 '承認済み'
'Disconnected'
'保留中'
'Rejected' (必須)

IotDpsSkuInfo

名前 説明
capacity プロビジョニングするユニット数 INT
name SKU 名。 'S1'

クイック スタート テンプレート

次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。

Template 説明
IOT ハブと Ubuntu エッジ シミュレーターを作成する

Azure にデプロイする
このテンプレートは、IOT ハブと仮想マシンの Ubuntu エッジ シミュレーターを作成します。
IoT Hub Device Provisioning Service を作成する

Azure にデプロイする
このテンプレートを使用すると、IoT ハブと IoT Hub Device Provisioning Service を作成し、2 つのサービスをリンクできます。

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

名前 説明
type リソースの種類 "Microsoft.Devices/provisioningServices@2023-03-01-preview"
name リソース名 string (必須)

文字制限: 3 から 64

有効な文字:
英数字とハイフン。

末尾には英数文字を使用します。
location リソースの場所。 string (必須)
parent_id リソース グループにデプロイするには、そのリソース グループの ID を使用します。 string (必須)
tags リソース タグ。 タグの名前と値のディクショナリ。
sku プロビジョニング サービスの SKU 情報。 IotDpsSkuInfo (必須)
etag Etag フィールドは必須 ではありません 。 応答本文で指定する場合は、通常の ETag 規則に従ってヘッダーとしても指定する必要があります。 string
identity プロビジョニング サービスのマネージド ID。 ManagedServiceIdentity
properties プロビジョニング サービスのサービス固有のプロパティ IotDpsPropertiesDescription (必須)
resourcegroup リソースのリソース グループ。 string
subscriptionid リソースのサブスクリプション ID。 string

ManagedServiceIdentity

名前 説明
type マネージド サービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。 "SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned" (必須)
identity_ids リソースに関連付けられているユーザー割り当て ID のセット。 userAssignedIdentities ディクショナリ キーは、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} という形式の ARM リソース ID になります。 ディクショナリ値は、要求で空のオブジェクト ({}) にすることができます。 ユーザー ID ID の配列。

UserAssignedIdentities

名前 説明
{カスタマイズされたプロパティ} UserAssignedIdentity

UserAssignedIdentity

このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。

IotDpsPropertiesDescription

名前 説明
allocationPolicy このプロビジョニング サービスで使用される割り当てポリシー。 "GeoLatency"
"Hashed"
"Static"
authorizationPolicies プロビジョニング サービスの承認キーの一覧。 SharedAccessSignatureAuthorizationRuleAccessRightsDe...[]
enableDataResidency 省略可能。
DPS インスタンスがData Residency有効になっているかどうかを示し、geo ペア間のディザスター リカバリーを削除します。
[bool]
iotHubs このプロビジョニング サービスに関連付けられている IoT ハブの一覧。 IotHubDefinitionDescription[]
ipFilterRules IP フィルター規則。 IpFilterRule[]
portalOperationsHostName このプロビジョニング サービスの CORS を有効にするポータル エンドポイント。 string
privateEndpointConnections この IotHub で作成されたプライベート エンドポイント接続 PrivateEndpointConnection[]
provisioningState プロビジョニング サービスの ARM プロビジョニング状態。 string
publicNetworkAccess パブリック ネットワークからの要求を許可するかどうか "無効"
"有効"
state プロビジョニング サービスの現在の状態。 "アクティブ化中"
"ActivationFailed"
"アクティブ"
"削除済み"
"削除中"
"DeletionFailed"
"FailingOver"
"FailoverFailed"
"再開中"
"中断"
"中断中"
"移行中"

SharedAccessSignatureAuthorizationRuleAccessRightsDe...

名前 説明
keyName キーの名前。 string (必須)
primaryKey プライマリ SAS キーの値。 string
権限 このキーに含まれる権限。 "DeviceConnect"
"EnrollmentRead"
"EnrollmentWrite"
"RegistrationStatusRead"
"RegistrationStatusWrite"
"ServiceConfig" (必須)
secondaryKey セカンダリ SAS キー値。 string
keyName キーの名前。 string (必須)
primaryKey プライマリ SAS キーの値。 string
権限 このキーに含まれる権限。 "DeviceConnect"
"EnrollmentRead"
"EnrollmentWrite"
"RegistrationStatusRead"
"RegistrationStatusWrite"
"ServiceConfig" (必須)
secondaryKey セカンダリ SAS キー値。 string

IotHubDefinitionDescription

名前 説明
allocationWeight 特定の iot h に適用する重み。 INT
applyAllocationPolicy 特定の iot ハブに allocationPolicy を適用する場合は フラグ。 [bool]
connectionString IoT ハブの接続文字列。 string (必須)
location IoT ハブの ARM リージョン。 string (必須)

IpFilterRule

名前 説明
action このルールによってキャプチャされた要求に対して必要なアクション。 "Accept"
"Reject" (必須)
filterName IP フィルター規則の名前。 string (必須)
ipMask 規則の IP アドレス範囲を CIDR 表記で含む文字列。 string (必須)
ターゲット (target) このルールによってキャプチャされた要求のターゲット。 "all"
"deviceApi"
"serviceApi"

PrivateEndpointConnection

名前 説明
properties プライベート エンドポイント接続のプロパティ PrivateEndpointConnectionProperties (必須)

PrivateEndpointConnectionProperties

名前 説明
privateEndpoint プライベート エンドポイント接続のプライベート エンドポイント プロパティ PrivateEndpoint
privateLinkServiceConnectionState プライベート エンドポイント接続の現在の状態 PrivateLinkServiceConnectionState (必須)

PrivateEndpoint

このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。

PrivateLinkServiceConnectionState

名前 説明
actionsRequired プライベート エンドポイント接続に必要なアクション string
description プライベート エンドポイント接続の現在の状態の説明 string (必須)
status プライベート エンドポイント接続の状態 "承認済み"
"切断済み"
"保留中"
"Rejected" (必須)

IotDpsSkuInfo

名前 説明
capacity プロビジョニングするユニットの数 INT
name SKU 名。 "S1"