Available Endpoint Services - List

List what values of endpoint services are available for use.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/virtualNetworkAvailableEndpointServices?api-version=2024-05-01

URI Parameters

Name In Required Type Description
location
path True

string

The location to check available endpoint services.

subscriptionId
path True

string

The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

api-version
query True

string

Client API version.

Responses

Name Type Description
200 OK

EndpointServicesListResult

Request successful. Returns list of available endpoint services.

Other Status Codes

CloudError

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

EndpointServicesList

Sample request

GET https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/westus/virtualNetworkAvailableEndpointServices?api-version=2024-05-01

Sample response

{
  "value": [
    {
      "name": "Microsoft.Storage",
      "id": "/subscriptions/subid/providers/Microsoft.Network/virtualNetworkEndpointServices/Microsoft.Storage",
      "type": "Microsoft.Network/virtualNetworkEndpointServices"
    },
    {
      "name": "Microsoft.Sql",
      "id": "/subscriptions/subid/providers/Microsoft.Network/virtualNetworkEndpointServices/Microsoft.Sql",
      "type": "Microsoft.Network/virtualNetworkEndpointServices"
    },
    {
      "name": "Microsoft.AzureActiveDirectory",
      "id": "/subscriptions/subid/providers/Microsoft.Network/virtualNetworkEndpointServices/Microsoft.AzureActiveDirectory",
      "type": "Microsoft.Network/virtualNetworkEndpointServices"
    }
  ]
}

Definitions

Name Description
CloudError

An error response from the service.

CloudErrorBody

An error response from the service.

EndpointServiceResult

Endpoint service.

EndpointServicesListResult

Response for the ListAvailableEndpointServices API service call.

CloudError

An error response from the service.

Name Type Description
error

CloudErrorBody

Cloud error body.

CloudErrorBody

An error response from the service.

Name Type Description
code

string

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

details

CloudErrorBody[]

A list of additional details about the error.

message

string

A message describing the error, intended to be suitable for display in a user interface.

target

string

The target of the particular error. For example, the name of the property in error.

EndpointServiceResult

Endpoint service.

Name Type Description
id

string

Resource ID.

name

string

Name of the endpoint service.

type

string

Type of the endpoint service.

EndpointServicesListResult

Response for the ListAvailableEndpointServices API service call.

Name Type Description
nextLink

string

The URL to get the next set of results.

value

EndpointServiceResult[]

List of available endpoint services in a region.