Share via


Available Service Aliases - List By Resource Group

Gets all available service aliases for this resource group in this region.

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

URI Parameters

Name In Required Type Description
location
path True

string

The location.

resourceGroupName
path True

string

The name of the resource group.

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

AvailableServiceAliasesResult

Request successful. Returns all available service aliases for the resource group in the region.

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

Get available service aliases in the resource group

Sample request

GET https://management.azure.com/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/locations/westcentralus/availableServiceAliases?api-version=2024-05-01

Sample response

{
  "value": [
    {
      "name": "servicesAzure",
      "id": "/subscriptions/subId/providers/Microsoft.Network/AvailableServiceAliases/servicesAzure",
      "type": "Microsoft.Network/AvailableServiceAliases",
      "resourceName": "/services/Azure"
    },
    {
      "name": "servicesAzureManagedInstance",
      "id": "/subscriptions/subId/providers/Microsoft.Network/AvailableServiceAliases/servicesAzureManagedInstance",
      "type": "Microsoft.Network/AvailableServiceAliases",
      "resourceName": "/services/Azure/ManagedInstance"
    }
  ]
}

Definitions

Name Description
AvailableServiceAlias

The available service alias.

AvailableServiceAliasesResult

An array of available service aliases.

CloudError

An error response from the service.

CloudErrorBody

An error response from the service.

AvailableServiceAlias

The available service alias.

Name Type Description
id

string

The ID of the service alias.

name

string

The name of the service alias.

resourceName

string

The resource name of the service alias.

type

string

The type of the resource.

AvailableServiceAliasesResult

An array of available service aliases.

Name Type Description
nextLink

string

The URL to get the next set of results.

value

AvailableServiceAlias[]

An array of available service aliases.

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.