PrivateEndpointConnection

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/microsoft-azure-batch/json-schema/microsoft-azure-batch-private-endpoint-connection-schema.json",
  "title": "PrivateEndpointConnection",
  "description": "Contains information about a private link resource.",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_superseded/microsoft-azure-batch-private-endpoint-connection-api-openapi.yml#/components/schemas/PrivateEndpointConnection",
  "type": "object",
  "properties": {
    "properties": {
      "$ref": "#/$defs/PrivateEndpointConnectionProperties",
      "description": "The properties associated with the private endpoint connection.",
      "x-ms-client-flatten": true
    },
    "etag": {
      "type": "string",
      "description": "The ETag of the resource, used for concurrency statements.",
      "readOnly": true
    },
    "tags": {
      "type": "object",
      "description": "The tags of the resource.",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "allOf": [
    {
      "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
    }
  ],
  "$defs": {
    "PrivateEndpoint": {
      "type": "object",
      "description": "The private endpoint of the private endpoint connection.",
      "properties": {
        "id": {
          "type": "string",
          "title": "The ARM resource identifier of the private endpoint. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}.",
          "description": "The ARM resource identifier of the private endpoint. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}.",
          "readOnly": true
        }
      }
    },
    "PrivateEndpointConnectionProperties": {
      "type": "object",
      "description": "Private endpoint connection properties.",
      "properties": {
        "provisioningState": {
          "$ref": "#/$defs/PrivateEndpointConnectionProvisioningState",
          "title": "The provisioning state of the private endpoint connection.",
          "description": "The provisioning state of the private endpoint connection.",
          "readOnly": true
        },
        "privateEndpoint": {
          "$ref": "#/$defs/PrivateEndpoint",
          "title": "The ARM resource identifier of the private endpoint.",
          "description": "The private endpoint of the private endpoint connection.",
          "readOnly": true
        },
        "groupIds": {
          "type": "array",
          "title": "The group id of the private endpoint connection.",
          "description": "The value has one and only one group id.",
          "items": {
            "type": "string"
          },
          "readOnly": true
        },
        "privateLinkServiceConnectionState": {
          "$ref": "#/$defs/PrivateLinkServiceConnectionState",
          "title": "The private link service connection state of the private endpoint connection.",
          "description": "The private link service connection state of the private endpoint connection."
        }
      }
    },
    "PrivateEndpointConnectionProvisioningState": {
      "type": "string",
      "description": "The provisioning state of the private endpoint connection.",
      "enum": [
        "Creating",
        "Updating",
        "Deleting",
        "Succeeded",
        "Failed",
        "Cancelled"
      ],
      "x-ms-enum": {
        "name": "PrivateEndpointConnectionProvisioningState",
        "modelAsString": false,
        "values": [
          {
            "name": "Creating",
            "value": "Creating",
            "description": "The connection is creating."
          },
          {
            "name": "Updating",
            "value": "Updating",
            "description": "The user has requested that the connection status be updated, but the update operation has not yet completed. You may not reference the connection when connecting the Batch account."
          },
          {
            "name": "Deleting",
            "value": "Deleting",
            "description": "The connection is deleting."
          },
          {
            "name": "Succeeded",
            "value": "Succeeded",
            "description": "The connection status is final and is ready for use if Status is Approved."
          },
          {
            "name": "Failed",
            "value": "Failed",
            "description": "The user requested that the connection be updated and it failed. You may retry the update operation."
          },
          {
            "name": "Cancelled",
            "value": "Cancelled",
            "description": "The user has cancelled the connection creation."
          }
        ]
      },
      "readOnly": true
    },
    "PrivateLinkServiceConnectionState": {
      "type": "object",
      "description": "The private link service connection state of the private endpoint connection",
      "properties": {
        "status": {
          "$ref": "#/$defs/PrivateLinkServiceConnectionStatus",
          "title": "The status of the Batch private endpoint connection",
          "description": "The status of the Batch private endpoint connection"
        },
        "description": {
          "type": "string",
          "title": "Description of the private Connection state",
          "description": "Description of the private Connection state"
        },
        "actionsRequired": {
          "type": "string",
          "title": "Action required on the private connection state",
          "description": "Action required on the private connection state",
          "readOnly": true
        }
      },
      "required": [
        "status"
      ]
    },
    "PrivateLinkServiceConnectionStatus": {
      "type": "string",
      "description": "The status of the Batch private endpoint connection",
      "enum": [
        "Approved",
        "Pending",
        "Rejected",
        "Disconnected"
      ],
      "x-ms-enum": {
        "name": "PrivateLinkServiceConnectionStatus",
        "modelAsString": false,
        "values": [
          {
            "name": "Approved",
            "value": "Approved",
            "description": "The private endpoint connection is approved and can be used to access Batch account"
          },
          {
            "name": "Pending",
            "value": "Pending",
            "description": "The private endpoint connection is pending and cannot be used to access Batch account"
          },
          {
            "name": "Rejected",
            "value": "Rejected",
            "description": "The private endpoint connection is rejected and cannot be used to access Batch account"
          },
          {
            "name": "Disconnected",
            "value": "Disconnected",
            "description": "The private endpoint connection is disconnected and cannot be used to access Batch account"
          }
        ]
      }
    }
  }
}