Microsoft.DocumentDB databaseAccounts/privateEndpointConnections 2021-07-01-preview

  • [アーティクル]

Bicep リソース定義

databaseAccounts/privateEndpointConnections リソースの種類は、次を対象とする操作でデプロイできます。

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

リソース形式

Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections@2021-07-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    groupId: 'string'
    privateEndpoint: {
      id: 'string'
    }
    privateLinkServiceConnectionState: {
      description: 'string'
      status: 'string'
    }
    provisioningState: 'string'
  }
}

プロパティ値

databaseAccounts/privateEndpointConnections

名前 説明 値
name リソース名

Bicep で子リソースの名前と型を設定する方法を参照してください。		 string (必須)
parent Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。

詳細については、「 親リソースの外部にある子リソース」を参照してください。		 種類のリソースのシンボリック名: databaseAccounts
properties リソースのプロパティ。 PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

名前 説明 値
groupId プライベート エンドポイントのグループ ID。 string
privateEndpoint 接続が属するプライベート エンドポイント。 PrivateEndpointProperty
privateLinkServiceConnectionState プライベート エンドポイント接続の接続状態。 PrivateLinkServiceConnectionStateProperty
provisioningState プライベート エンドポイントのプロビジョニング状態。 string

PrivateEndpointProperty

名前 説明 値
id プライベート エンドポイントのリソース ID。 string

PrivateLinkServiceConnectionStateProperty

名前 説明 値
description プライベート リンク サービス接続の説明。 string
status プライベート リンク サービスの接続状態。 string

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

databaseAccounts/privateEndpointConnections リソースの種類は、次を対象とする操作でデプロイできます。

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

リソース形式

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections",
  "apiVersion": "2021-07-01-preview",
  "name": "string",
  "properties": {
    "groupId": "string",
    "privateEndpoint": {
      "id": "string"
    },
    "privateLinkServiceConnectionState": {
      "description": "string",
      "status": "string"
    },
    "provisioningState": "string"
  }
}

プロパティ値

databaseAccounts/privateEndpointConnections

名前 説明 値
type リソースの種類 'Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections'
apiVersion リソース API のバージョン '2021-07-01-preview'
name リソース名

JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。		 string (必須)
properties リソースのプロパティ。 PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

名前 説明 値
groupId プライベート エンドポイントのグループ ID。 string
privateEndpoint 接続が属するプライベート エンドポイント。 PrivateEndpointProperty
privateLinkServiceConnectionState プライベート エンドポイント接続の接続状態。 PrivateLinkServiceConnectionStateProperty
provisioningState プライベート エンドポイントのプロビジョニング状態。 string

PrivateEndpointProperty

名前 説明 値
id プライベート エンドポイントのリソース ID。 string

PrivateLinkServiceConnectionStateProperty

名前 説明 値
description プライベート リンク サービスの接続の説明。 string
status プライベート リンク サービスの接続状態。 string

Terraform (AzAPI プロバイダー) リソース定義

databaseAccounts/privateEndpointConnections リソースの種類は、次を対象とする操作と共にデプロイできます。

  • リソース グループ

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

リソース形式

Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections@2021-07-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      groupId = "string"
      privateEndpoint = {
        id = "string"
      }
      privateLinkServiceConnectionState = {
        description = "string"
        status = "string"
      }
      provisioningState = "string"
    }
  })
}

プロパティ値

databaseAccounts/privateEndpointConnections

名前 説明 値
type リソースの種類 "Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections@2021-07-01-preview"
name リソース名 string (必須)
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: databaseAccounts
properties リソースのプロパティ。 PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

名前 説明 値
groupId プライベート エンドポイントのグループ ID。 string
privateEndpoint 接続が属するプライベート エンドポイント。 PrivateEndpointProperty
privateLinkServiceConnectionState プライベート エンドポイント接続の接続状態。 PrivateLinkServiceConnectionStateProperty
provisioningState プライベート エンドポイントのプロビジョニング状態。 string

PrivateEndpointProperty

名前 説明 値
id プライベート エンドポイントのリソース ID。 string

PrivateLinkServiceConnectionStateProperty

名前 説明 値
description プライベート リンク サービスの接続の説明。 string
status プライベート リンク サービスの接続状態。 string