PrivateEndpoint

{
  "$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-schema.json",
  "title": "PrivateEndpoint",
  "description": "Private endpoint resource.",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/microsoft-azure-private-link-private-endpoints-api-openapi.yml#/components/schemas/PrivateEndpoint",
  "properties": {
    "extendedLocation": {
      "$ref": "./network.json#/definitions/ExtendedLocation",
      "description": "The extended location of the load balancer."
    },
    "properties": {
      "x-ms-client-flatten": true,
      "$ref": "#/$defs/PrivateEndpointProperties",
      "description": "Properties of the private endpoint."
    },
    "etag": {
      "readOnly": true,
      "type": "string",
      "description": "A unique read-only string that changes whenever the resource is updated."
    }
  },
  "allOf": [
    {
      "$ref": "./network.json#/definitions/Resource"
    }
  ],
  "$defs": {
    "CustomDnsConfigPropertiesFormat": {
      "properties": {
        "fqdn": {
          "type": "string",
          "description": "Fqdn that resolves to private endpoint ip address."
        },
        "ipAddresses": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "A list of private ip addresses of the private endpoint."
        }
      },
      "description": "Contains custom Dns resolution configuration from customer."
    },
    "PrivateEndpointIPConfiguration": {
      "type": "object",
      "properties": {
        "properties": {
          "x-ms-client-flatten": true,
          "$ref": "#/$defs/PrivateEndpointIPConfigurationProperties",
          "description": "Properties of private endpoint IP configurations."
        },
        "name": {
          "type": "string",
          "description": "The name of the resource that is unique within a resource group."
        },
        "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."
        }
      },
      "description": "An IP Configuration of the private endpoint."
    },
    "PrivateEndpointIPConfigurationProperties": {
      "type": "object",
      "properties": {
        "groupId": {
          "type": "string",
          "description": "The ID of a group obtained from the remote resource that this private endpoint should connect to."
        },
        "memberName": {
          "type": "string",
          "description": "The member name of a group obtained from the remote resource that this private endpoint should connect to."
        },
        "privateIPAddress": {
          "type": "string",
          "description": "A private ip address obtained from the private endpoint's subnet."
        }
      },
      "description": "Properties of an IP Configuration of the private endpoint."
    },
    "PrivateEndpointProperties": {
      "properties": {
        "subnet": {
          "$ref": "./virtualNetwork.json#/definitions/Subnet",
          "description": "The ID of the subnet from which the private IP will be allocated."
        },
        "networkInterfaces": {
          "type": "array",
          "readOnly": true,
          "items": {
            "$ref": "./networkInterface.json#/definitions/NetworkInterface"
          },
          "description": "An array of references to the network interfaces created for this private endpoint."
        },
        "provisioningState": {
          "readOnly": true,
          "$ref": "./network.json#/definitions/ProvisioningState",
          "description": "The provisioning state of the private endpoint resource."
        },
        "ipVersionType": {
          "type": "string",
          "description": "Specifies the IP version type for the private IPs of the private endpoint. If not defined, this defaults to IPv4.",
          "enum": [
            "IPv4",
            "IPv6",
            "DualStack"
          ],
          "default": "IPv4",
          "x-ms-enum": {
            "name": "PrivateEndpointIPVersionType",
            "modelAsString": true,
            "values": [
              {
                "name": "IPv4",
                "value": "IPv4",
                "description": "Indicates that the Private IPs of the private endpoint will be IPv4 only."
              },
              {
                "name": "IPv6",
                "value": "IPv6",
                "description": "Indicates that the Private IPs of the private endpoint will be IPv6 only."
              },
              {
                "name": "DualStack",
                "value": "DualStack",
                "description": "Indicates that the Private IPs of the private endpoint can be both IPv4 and IPv6."
              }
            ]
          }
        },
        "privateLinkServiceConnections": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/PrivateLinkServiceConnection"
          },
          "description": "A grouping of information about the connection to the remote resource."
        },
        "manualPrivateLinkServiceConnections": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/PrivateLinkServiceConnection"
          },
          "description": "A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource."
        },
        "customDnsConfigs": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/CustomDnsConfigPropertiesFormat"
          },
          "description": "An array of custom dns configurations."
        },
        "applicationSecurityGroups": {
          "type": "array",
          "items": {
            "$ref": "./applicationSecurityGroup.json#/definitions/ApplicationSecurityGroup"
          },
          "description": "Application security groups in which the private endpoint IP configuration is included."
        },
        "ipConfigurations": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/PrivateEndpointIPConfiguration"
          },
          "description": "A list of IP configurations of the private endpoint. This will be used to map to the First Party Service's endpoints."
        },
        "customNetworkInterfaceName": {
          "type": "string",
          "description": "The custom name of the network interface attached to the private endpoint."
        }
      },
      "description": "Properties of the private endpoint."
    },
    "PrivateLinkServiceConnection": {
      "properties": {
        "properties": {
          "x-ms-client-flatten": true,
          "$ref": "#/$defs/PrivateLinkServiceConnectionProperties",
          "description": "Properties of the private link service 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"
        }
      ],
      "description": "PrivateLinkServiceConnection resource."
    },
    "PrivateLinkServiceConnectionProperties": {
      "properties": {
        "provisioningState": {
          "readOnly": true,
          "$ref": "./network.json#/definitions/ProvisioningState",
          "description": "The provisioning state of the private link service connection resource."
        },
        "privateLinkServiceId": {
          "type": "string",
          "description": "The resource id of private link service."
        },
        "groupIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to."
        },
        "requestMessage": {
          "type": "string",
          "description": "A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars."
        },
        "privateLinkServiceConnectionState": {
          "$ref": "./privateLinkService.json#/definitions/PrivateLinkServiceConnectionState",
          "description": "A collection of read-only information about the state of the connection to the remote resource."
        }
      },
      "description": "Properties of the PrivateLinkServiceConnection."
    }
  }
}