PrivateEndpointConnectionList

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/microsoft-azure-web-pubsub/json-schema/microsoft-azure-web-pubsub-private-endpoint-connection-list-schema.json",
  "title": "PrivateEndpointConnectionList",
  "description": "A list of private endpoint connections",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/microsoft-azure-web-pubsub-management-api-openapi.yml#/components/schemas/PrivateEndpointConnectionList",
  "type": "object",
  "properties": {
    "value": {
      "description": "The list of the private endpoint connections",
      "type": "array",
      "items": {
        "$ref": "#/$defs/PrivateEndpointConnection"
      },
      "x-ms-identifiers": []
    },
    "nextLink": {
      "description": "Request URL that can be used to query next page of private endpoint connections. Returned when the total number of requested private endpoint connections exceed maximum page size.",
      "type": "string"
    }
  },
  "$defs": {
    "PrivateEndpoint": {
      "description": "Private endpoint",
      "type": "object",
      "properties": {
        "id": {
          "description": "Full qualified Id of the private endpoint",
          "type": "string"
        }
      }
    },
    "PrivateEndpointConnection": {
      "description": "A private endpoint connection to an azure resource",
      "type": "object",
      "allOf": [
        {
          "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
        }
      ],
      "properties": {
        "properties": {
          "$ref": "#/$defs/PrivateEndpointConnectionProperties"
        }
      }
    },
    "PrivateEndpointConnectionProperties": {
      "description": "Private endpoint connection properties",
      "type": "object",
      "properties": {
        "provisioningState": {
          "$ref": "#/$defs/ProvisioningState"
        },
        "privateEndpoint": {
          "$ref": "#/$defs/PrivateEndpoint"
        },
        "groupIds": {
          "description": "Group IDs",
          "type": "array",
          "items": {
            "type": "string"
          },
          "readOnly": true,
          "x-ms-identifiers": []
        },
        "privateLinkServiceConnectionState": {
          "$ref": "#/$defs/PrivateLinkServiceConnectionState"
        }
      }
    },
    "PrivateLinkServiceConnectionState": {
      "description": "Connection state of the private endpoint connection",
      "type": "object",
      "properties": {
        "status": {
          "$ref": "#/$defs/PrivateLinkServiceConnectionStatus"
        },
        "description": {
          "description": "The reason for approval/rejection of the connection.",
          "type": "string"
        },
        "actionsRequired": {
          "description": "A message indicating if changes on the service provider require any updates on the consumer.",
          "type": "string"
        }
      }
    },
    "PrivateLinkServiceConnectionStatus": {
      "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.",
      "enum": [
        "Pending",
        "Approved",
        "Rejected",
        "Disconnected"
      ],
      "type": "string",
      "x-ms-enum": {
        "name": "PrivateLinkServiceConnectionStatus",
        "modelAsString": true
      }
    },
    "ProvisioningState": {
      "description": "Provisioning state of the resource.",
      "enum": [
        "Unknown",
        "Succeeded",
        "Failed",
        "Canceled",
        "Running",
        "Creating",
        "Updating",
        "Deleting",
        "Moving"
      ],
      "type": "string",
      "readOnly": true,
      "x-ms-enum": {
        "name": "ProvisioningState",
        "modelAsString": true
      }
    }
  }
}