Freigeben über


Microsoft.DocumentDB databaseAccounts/privateEndpointConnections

Bicep-Ressourcendefinition

Der Ressourcentyp databaseAccounts/privateEndpointConnections kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.

Ressourcenformat

Um eine Ressource Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections zu erstellen, fügen Sie ihrer Vorlage den folgenden Bicep hinzu.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections@2024-05-15' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    groupId: 'string'
    privateEndpoint: {
      id: 'string'
    }
    privateLinkServiceConnectionState: {
      description: 'string'
      status: 'string'
    }
    provisioningState: 'string'
  }
}

Eigenschaftswerte

databaseAccounts/privateEndpointConnections

Name BESCHREIBUNG Wert
name Der Ressourcenname

Weitere Informationen finden Sie unter Festlegen von Namen und Typen für untergeordnete Ressourcen in Bicep.
Zeichenfolge (erforderlich)
parent In Bicep können Sie die übergeordnete Ressource für eine untergeordnete Ressource angeben. Sie müssen diese Eigenschaft nur hinzufügen, wenn die untergeordnete Ressource außerhalb der übergeordneten Ressource deklariert wird.

Weitere Informationen finden Sie unter Untergeordnete Ressource außerhalb der übergeordneten Ressource.
Symbolischer Name für Ressource vom Typ: databaseAccounts
properties Ressourceneigenschaften. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Name BESCHREIBUNG Wert
groupId Gruppen-ID des privaten Endpunkts. Zeichenfolge
privateEndpoint Privater Endpunkt, zu dem die Verbindung gehört. PrivateEndpointProperty
privateLinkServiceConnectionState Verbindungsstatus der Verbindung mit dem privaten Endpunkt. PrivateLinkServiceConnectionStateProperty
provisioningState Bereitstellungsstatus des privaten Endpunkts. Zeichenfolge

PrivateEndpointProperty

Name BESCHREIBUNG Wert
id Ressourcen-ID des privaten Endpunkts. Zeichenfolge

PrivateLinkServiceConnectionStateProperty

Name BESCHREIBUNG Wert
description Die Verbindungsbeschreibung des Private Link-Diensts. Zeichenfolge
status Der Verbindungsstatus des Private Link-Diensts. Zeichenfolge

Ressourcendefinition mit einer ARM-Vorlage

Der Ressourcentyp databaseAccounts/privateEndpointConnections kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.

Ressourcenformat

Um eine Ressource Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections",
  "apiVersion": "2024-05-15",
  "name": "string",
  "properties": {
    "groupId": "string",
    "privateEndpoint": {
      "id": "string"
    },
    "privateLinkServiceConnectionState": {
      "description": "string",
      "status": "string"
    },
    "provisioningState": "string"
  }
}

Eigenschaftswerte

databaseAccounts/privateEndpointConnections

Name BESCHREIBUNG Wert
type Ressourcentyp "Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections"
apiVersion Die Ressourcen-API-Version '2024-05-15'
name Der Ressourcenname

Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in JSON-ARM-Vorlagen festlegen.
Zeichenfolge (erforderlich)
properties Ressourceneigenschaften. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Name BESCHREIBUNG Wert
groupId Gruppen-ID des privaten Endpunkts. Zeichenfolge
privateEndpoint Privater Endpunkt, zu dem die Verbindung gehört. PrivateEndpointProperty
privateLinkServiceConnectionState Verbindungsstatus der Verbindung mit dem privaten Endpunkt. PrivateLinkServiceConnectionStateProperty
provisioningState Bereitstellungsstatus des privaten Endpunkts. Zeichenfolge

PrivateEndpointProperty

Name BESCHREIBUNG Wert
id Ressourcen-ID des privaten Endpunkts. Zeichenfolge

PrivateLinkServiceConnectionStateProperty

Name BESCHREIBUNG Wert
description Die Verbindungsbeschreibung des Private Link-Diensts. Zeichenfolge
status Der Private Link-Dienstverbindungsstatus. Zeichenfolge

Terraform (AzAPI-Anbieter) Ressourcendefinition

Der Ressourcentyp databaseAccounts/privateEndpointConnections kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:

  • Ressourcengruppen

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections-Ressource zu erstellen, fügen Sie Der Vorlage die folgende Terraform-Ressource hinzu.

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

Eigenschaftswerte

databaseAccounts/privateEndpointConnections

Name BESCHREIBUNG Wert
type Ressourcentyp "Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections@2024-05-15"
name Der Ressourcenname Zeichenfolge (erforderlich)
parent_id Die ID der Ressource, die die übergeordnete Ressource für diese Ressource ist. ID für Ressource vom Typ: databaseAccounts
properties Ressourceneigenschaften. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Name BESCHREIBUNG Wert
groupId Gruppen-ID des privaten Endpunkts. Zeichenfolge
privateEndpoint Privater Endpunkt, zu dem die Verbindung gehört. PrivateEndpointProperty
privateLinkServiceConnectionState Verbindungsstatus der Verbindung mit dem privaten Endpunkt. PrivateLinkServiceConnectionStateProperty
provisioningState Bereitstellungsstatus des privaten Endpunkts. Zeichenfolge

PrivateEndpointProperty

Name BESCHREIBUNG Wert
id Ressourcen-ID des privaten Endpunkts. Zeichenfolge

PrivateLinkServiceConnectionStateProperty

Name BESCHREIBUNG Wert
description Die Verbindungsbeschreibung des Private Link-Diensts. Zeichenfolge
status Der Private Link-Dienstverbindungsstatus. Zeichenfolge