Microsoft.Devices provisioningServices 2022-12-12

• 最新の を する
• 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@2022-12-12' = {
  etag: 'string'
  location: 'string'
  name: 'string'
  properties: {
    allocationPolicy: 'string'
    authorizationPolicies: [
      {
        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'
  sku: {
    capacity: int
    name: 'string'
  }
  subscriptionid: 'string'
  tags: {
    {customized property}: 'string'
  }
}

プロパティ値

IotDpsPropertiesDescription

名前	形容	価値
allocationPolicy	このプロビジョニング サービスで使用される割り当てポリシー。	'GeoLatency' 'Hashed' 'Static'
authorizationPolicies	プロビジョニング サービスの承認キーの一覧。	SharedAccessSignatureAuthorizationRuleAccessRightsDescription[]
enableDataResidency	随意。 DPS インスタンスで Data Residency が有効になっているかどうかを示し、geo ペア間のディザスター リカバリーを削除します。	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'

IotDpsSkuInfo

名前	形容	価値
能力	プロビジョニングするユニット数	int
名前	SKU 名。	'S1'

IotHubDefinitionDescription

名前	形容	価値
allocationWeight	特定の IoT h に適用する重み。	int
applyAllocationPolicy	特定の IoT ハブに対して allocationPolicy を適用するかどうかを示すフラグ。	bool
connectionString	IoT ハブの接続文字列。	string (必須)
場所	IoT ハブの ARM リージョン。	string (必須)

IpFilterRule

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

Microsoft.Devices/provisioningServices

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

PrivateEndpoint

名前	形容	価値

PrivateEndpointConnection

名前	形容	価値
プロパティ	プライベート エンドポイント接続のプロパティ	PrivateEndpointConnectionProperties (必須)

PrivateEndpointConnectionProperties

名前	形容	価値
privateEndpoint	プライベート エンドポイント接続のプライベート エンドポイント プロパティ	PrivateEndpoint を する
privateLinkServiceConnectionState	プライベート エンドポイント接続の現在の状態	PrivateLinkServiceConnectionState (必須)

PrivateLinkServiceConnectionState

名前	形容	価値
actionsRequired	プライベート エンドポイント接続に必要なアクション	糸
形容	プライベート エンドポイント接続の現在の状態の説明	string (必須)
地位	プライベート エンドポイント接続の状態	'Approved' 'Disconnected' 'Pending' 'Rejected' (必須)

ResourceTags

名前	形容	価値

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

名前	形容	価値
keyName	キーの名前。	string (必須)
primaryKey	プライマリ SAS キーの値。	糸
権利	このキーが持つ権限。	'DeviceConnect' 'EnrollmentRead' 'EnrollmentWrite' 'RegistrationStatusRead' 'RegistrationStatusWrite' 'ServiceConfig' (必須)
secondaryKey	セカンダリ SAS キー値。	糸

クイック スタートのサンプル

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

Bicep ファイル	形容
IoT Hub Device Provisioning Service を作成する	このテンプレートを使用すると、IoT ハブと IoT Hub Device Provisioning Service を作成し、2 つのサービスをリンクできます。

ARM テンプレート リソース定義

provisioningServices リソースの種類は、次をターゲットとする操作と共にデプロイできます。

• リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.Devices/provisioningServices リソースを作成するには、次の JSON をテンプレートに追加します。

{
  "type": "Microsoft.Devices/provisioningServices",
  "apiVersion": "2022-12-12",
  "name": "string",
  "etag": "string",
  "location": "string",
  "properties": {
    "allocationPolicy": "string",
    "authorizationPolicies": [
      {
        "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",
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "subscriptionid": "string",
  "tags": {
    "{customized property}": "string"
  }
}

プロパティ値

IotDpsPropertiesDescription

名前	形容	価値
allocationPolicy	このプロビジョニング サービスで使用される割り当てポリシー。	'GeoLatency' 'Hashed' 'Static'
authorizationPolicies	プロビジョニング サービスの承認キーの一覧。	SharedAccessSignatureAuthorizationRuleAccessRightsDescription[]
enableDataResidency	随意。 DPS インスタンスで Data Residency が有効になっているかどうかを示し、geo ペア間のディザスター リカバリーを削除します。	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'

IotDpsSkuInfo

名前	形容	価値
能力	プロビジョニングするユニット数	int
名前	SKU 名。	'S1'

IotHubDefinitionDescription

名前	形容	価値
allocationWeight	特定の IoT h に適用する重み。	int
applyAllocationPolicy	特定の IoT ハブに対して allocationPolicy を適用するかどうかを示すフラグ。	bool
connectionString	IoT ハブの接続文字列。	string (必須)
場所	IoT ハブの ARM リージョン。	string (必須)

IpFilterRule

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

Microsoft.Devices/provisioningServices

名前	形容	価値
apiVersion	API のバージョン	'2022-12-12'
etag	Etag フィールドは 必要ありません。 応答本文で指定する場合は、通常の ETag 規則に従ってヘッダーとしても指定する必要があります。	糸
場所	リソースの場所。	string (必須)
名前	リソース名	string (必須)
プロパティ	プロビジョニング サービスのサービス固有のプロパティ	IotDpsPropertiesDescription (必須)
resourcegroup	リソースのリソース グループ。	糸
sku	プロビジョニング サービスの SKU 情報。	IotDpsSkuInfo (必須)
subscriptionid	リソースのサブスクリプション ID。	糸
タグ	リソース タグ	タグ名と値のディクショナリ。 テンプレート の タグを参照してください
種類	リソースの種類	'Microsoft.Devices/provisioningServices'

PrivateEndpoint

名前	形容	価値

PrivateEndpointConnection

名前	形容	価値
プロパティ	プライベート エンドポイント接続のプロパティ	PrivateEndpointConnectionProperties (必須)

PrivateEndpointConnectionProperties

名前	形容	価値
privateEndpoint	プライベート エンドポイント接続のプライベート エンドポイント プロパティ	PrivateEndpoint を する
privateLinkServiceConnectionState	プライベート エンドポイント接続の現在の状態	PrivateLinkServiceConnectionState (必須)

PrivateLinkServiceConnectionState

名前	形容	価値
actionsRequired	プライベート エンドポイント接続に必要なアクション	糸
形容	プライベート エンドポイント接続の現在の状態の説明	string (必須)
地位	プライベート エンドポイント接続の状態	'Approved' 'Disconnected' 'Pending' 'Rejected' (必須)

ResourceTags

名前	形容	価値

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

名前	形容	価値
keyName	キーの名前。	string (必須)
primaryKey	プライマリ SAS キーの値。	糸
権利	このキーが持つ権限。	'DeviceConnect' 'EnrollmentRead' 'EnrollmentWrite' 'RegistrationStatusRead' 'RegistrationStatusWrite' 'ServiceConfig' (必須)
secondaryKey	セカンダリ SAS キー値。	糸

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

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

テンプレート	形容
IoT Hub と 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@2022-12-12"
  name = "string"
  etag = "string"
  location = "string"
  body = jsonencode({
    properties = {
      allocationPolicy = "string"
      authorizationPolicies = [
        {
          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"
  sku = {
    capacity = int
    name = "string"
  }
  subscriptionid = "string"
  tags = {
    {customized property} = "string"
  }
}

プロパティ値

IotDpsPropertiesDescription

名前	形容	価値
allocationPolicy	このプロビジョニング サービスで使用される割り当てポリシー。	'GeoLatency' 'Hashed' 'Static'
authorizationPolicies	プロビジョニング サービスの承認キーの一覧。	SharedAccessSignatureAuthorizationRuleAccessRightsDescription[]
enableDataResidency	随意。 DPS インスタンスで Data Residency が有効になっているかどうかを示し、geo ペア間のディザスター リカバリーを削除します。	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'

IotDpsSkuInfo

名前	形容	価値
能力	プロビジョニングするユニット数	int
名前	SKU 名。	'S1'

IotHubDefinitionDescription

名前	形容	価値
allocationWeight	特定の IoT h に適用する重み。	int
applyAllocationPolicy	特定の IoT ハブに対して allocationPolicy を適用するかどうかを示すフラグ。	bool
connectionString	IoT ハブの接続文字列。	string (必須)
場所	IoT ハブの ARM リージョン。	string (必須)

IpFilterRule

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

Microsoft.Devices/provisioningServices

名前	形容	価値
etag	Etag フィールドは 必要ありません。 応答本文で指定する場合は、通常の ETag 規則に従ってヘッダーとしても指定する必要があります。	糸
場所	リソースの場所。	string (必須)
名前	リソース名	string (必須)
プロパティ	プロビジョニング サービスのサービス固有のプロパティ	IotDpsPropertiesDescription (必須)
resourcegroup	リソースのリソース グループ。	糸
sku	プロビジョニング サービスの SKU 情報。	IotDpsSkuInfo (必須)
subscriptionid	リソースのサブスクリプション ID。	糸
タグ	リソース タグ	タグ名と値のディクショナリ。
種類	リソースの種類	"Microsoft.Devices/provisioningServices@2022-12-12"

PrivateEndpoint

名前	形容	価値

PrivateEndpointConnection

名前	形容	価値
プロパティ	プライベート エンドポイント接続のプロパティ	PrivateEndpointConnectionProperties (必須)

PrivateEndpointConnectionProperties

名前	形容	価値
privateEndpoint	プライベート エンドポイント接続のプライベート エンドポイント プロパティ	PrivateEndpoint を する
privateLinkServiceConnectionState	プライベート エンドポイント接続の現在の状態	PrivateLinkServiceConnectionState (必須)

PrivateLinkServiceConnectionState

名前	形容	価値
actionsRequired	プライベート エンドポイント接続に必要なアクション	糸
形容	プライベート エンドポイント接続の現在の状態の説明	string (必須)
地位	プライベート エンドポイント接続の状態	'Approved' 'Disconnected' 'Pending' 'Rejected' (必須)

ResourceTags

名前	形容	価値

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

名前	形容	価値
keyName	キーの名前。	string (必須)
primaryKey	プライマリ SAS キーの値。	糸
権利	このキーが持つ権限。	'DeviceConnect' 'EnrollmentRead' 'EnrollmentWrite' 'RegistrationStatusRead' 'RegistrationStatusWrite' 'ServiceConfig' (必須)
secondaryKey	セカンダリ SAS キー値。	糸