PrivateEndpointConnection

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/microsoft-azure-private-link/json-schema/microsoft-azure-private-link-private-endpoint-connection-schema.json",
  "title": "PrivateEndpointConnection",
  "description": "PrivateEndpointConnection resource.",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/microsoft-azure-private-link-privatelinkservices-api-openapi.yml#/components/schemas/PrivateEndpointConnection",
  "properties": {
    "properties": {
      "x-ms-client-flatten": true,
      "$ref": "#/$defs/PrivateEndpointConnectionProperties",
      "description": "Properties of the private end point connection."
    },
    "name": {
      "type": "string",
      "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource."
    },
    "type": {
      "readOnly": true,
      "type": "string",
      "description": "The resource type."
    },
    "etag": {
      "readOnly": true,
      "type": "string",
      "description": "A unique read-only string that changes whenever the resource is updated."
    }
  },
  "allOf": [
    {
      "$ref": "./network.json#/definitions/SubResource"
    }
  ],
  "$defs": {
    "PrivateEndpointConnectionProperties": {
      "properties": {
        "privateEndpoint": {
          "readOnly": true,
          "$ref": "./privateEndpoint.json#/definitions/PrivateEndpoint",
          "description": "The resource of private end point."
        },
        "privateLinkServiceConnectionState": {
          "$ref": "#/$defs/PrivateLinkServiceConnectionState",
          "description": "A collection of information about the state of the connection between service consumer and provider."
        },
        "provisioningState": {
          "readOnly": true,
          "$ref": "./network.json#/definitions/ProvisioningState",
          "description": "The provisioning state of the private endpoint connection resource."
        },
        "linkIdentifier": {
          "readOnly": true,
          "type": "string",
          "description": "The consumer link id."
        },
        "privateEndpointLocation": {
          "readOnly": true,
          "type": "string",
          "description": "The location of the private endpoint."
        }
      },
      "description": "Properties of the PrivateEndpointConnectProperties."
    },
    "PrivateLinkServiceConnectionState": {
      "properties": {
        "status": {
          "type": "string",
          "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service."
        },
        "description": {
          "type": "string",
          "description": "The reason for approval/rejection of the connection."
        },
        "actionsRequired": {
          "type": "string",
          "description": "A message indicating if changes on the service provider require any updates on the consumer."
        }
      },
      "description": "A collection of information about the state of the connection between service consumer and provider."
    }
  }
}