PrivateEndpointConnection interface

Package:

@azure/arm-cosmosdb

A private endpoint connection

Extends

ProxyResource

Properties

groupId	Group id of the private endpoint.
privateEndpoint	Private endpoint which the connection belongs to.
privateLinkServiceConnectionState	Connection State of the Private Endpoint Connection.
provisioningState	Provisioning state of the private endpoint.

Inherited Properties

id	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.
name	The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

groupId

Group id of the private endpoint.

groupId?: string

Property Value

string

privateEndpoint

Private endpoint which the connection belongs to.

privateEndpoint?: PrivateEndpointProperty

Property Value

PrivateEndpointProperty

privateLinkServiceConnectionState

Connection State of the Private Endpoint Connection.

privateLinkServiceConnectionState?: PrivateLinkServiceConnectionStateProperty

Property Value

PrivateLinkServiceConnectionStateProperty

provisioningState

Provisioning state of the private endpoint.

provisioningState?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From ProxyResource.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResource.type