# The Endpoint object

Endpoint represents a cloud networking resource in a user's cloud account and binds it to the <Databricks> account.

## Attributes

- `name` (string)
  The resource name of the endpoint, which uniquely identifies the endpoint.
  Example: `accounts/123e4567-e89b-12d3-a456-426614174000/endpoints/123e4567-e89b-12d3-a456-426614174000`
- `endpoint_id` (string)
  The unique identifier for this endpoint under the account. This field is a UUID generated by <Databricks>.
  Example: `123e4567-e89b-12d3-a456-426614174000`
- `account_id` (string)
  The Databricks Account in which the endpoint object exists.
  Example: `123e4567-e89b-12d3-a456-426614174000`
- `display_name` (string)
  The human-readable display name of this endpoint.
   The input should conform to RFC-1034, which restricts to letters, numbers, and hyphens,
   with the first character a letter, the last a letter or a number, and a 63 character maximum.
  Example: `example-endpoint`
- `use_case` (string)
  The use case that determines the type of network connectivity this endpoint provides.
   This field is automatically determined based on the endpoint configuration and cloud-specific settings.
  Possible values: `SERVICE_DIRECT`
- `region` (string)
  The cloud provider region where this endpoint is located.
- `state` (string)
  The state of the endpoint. The endpoint can only be used if the state is `APPROVED`.
  Possible values: `PENDING`, `APPROVED`, `FAILED`, `DISCONNECTED`
- `azure_private_endpoint_info` (object)
  Info for an Azure private endpoint.
  - `private_endpoint_name` (string)
    The name of the Private Endpoint in the Azure subscription.
    Example: `example-private-endpoint`
  - `private_endpoint_resource_guid` (string)
    The GUID of the Private Endpoint resource in the Azure subscription.
     This is assigned by Azure when the user sets up the Private Endpoint.
    Example: `123e4567-e89b-12d3-a456-426614174000`
  - `private_endpoint_resource_id` (string)
    The full resource ID of the Private Endpoint.
  - `private_link_service_id` (string)
    The resource ID of the Databricks Private Link Service that this Private Endpoint connects to.
    Example: `/subscriptions/123e4567-e89b-12d3-a456-426614174000/resourceGroups/resource-group/Microsoft.Databricks/workspaces`
- `create_time` (string)
  The timestamp when the endpoint was created. The timestamp is in RFC 3339 format in UTC timezone.
  Example: `2024-01-15T10:30:00.000Z`

## Example

```json
{
  "name": "accounts/123e4567-e89b-12d3-a456-426614174000/endpoints/123e4567-e89b-12d3-a456-426614174000",
  "endpoint_id": "123e4567-e89b-12d3-a456-426614174000",
  "account_id": "123e4567-e89b-12d3-a456-426614174000",
  "display_name": "example-endpoint",
  "use_case": "string",
  "region": "string",
  "state": "string",
  "azure_private_endpoint_info": {
    "private_endpoint_name": "example-private-endpoint",
    "private_endpoint_resource_guid": "123e4567-e89b-12d3-a456-426614174000",
    "private_endpoint_resource_id": "/subscriptions/123e4567-e89b-12d3-a456-426614174000/resourceGroups/resource-group/Microsoft.Databricks/workspaces/dbworkspaces/dbworkspace/dbPrivateEndpointConnections/example-private-endpoint.123e4567-e89b-12d3-a456-426614174000",
    "private_link_service_id": "/subscriptions/123e4567-e89b-12d3-a456-426614174000/resourceGroups/resource-group/Microsoft.Databricks/workspaces"
  },
  "create_time": "2024-01-15T10:30:00.000Z"
}
```