Resource Navigation Links - List

Gets a list of resource navigation links for a subnet.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}/ResourceNavigationLinks?api-version=2024-03-01

URI Parameters

Name In Required Type Description
resourceGroupName
path True

string

The name of the resource group.

subnetName
path True

string

The name of the subnet.

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.

virtualNetworkName
path True

string

The name of the virtual network.

api-version
query True

string

Client API version.

Responses

Name Type Description
200 OK

ResourceNavigationLinksListResult

Request successful. The operation returns a list of resource navigation links for the subnet.

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

Sample request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet/subnets/subnet/ResourceNavigationLinks?api-version=2024-03-01

Sample response

{
  "value": [
    {
      "name": "redisCache_redis-tester",
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet/subnets/subnet/resourceNavigationLinks/redisCache_redis-tester",
      "etag": "W/\"00000000-0000-0000-0000-000000000000\"",
      "type": "Microsoft.Network/virtualNetworks/subnets/resourceNavigationLinks",
      "properties": {
        "provisioningState": "Succeeded",
        "linkedResourceType": "Microsoft.Cache/redis",
        "link": "/subscriptions/subid/resourceGroups/another-rg/providers/Microsoft.Cache/Redis/redis-tester"
      }
    }
  ]
}

Definitions

Name Description
CloudError

An error response from the service.

CloudErrorBody

An error response from the service.

ProvisioningState

The current provisioning state.

ResourceNavigationLink

ResourceNavigationLink resource.

ResourceNavigationLinksListResult

Response for ResourceNavigationLinks_List operation.

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.

ProvisioningState

The current provisioning state.

Name Type Description
Deleting

string

Failed

string

Succeeded

string

Updating

string

ResourceNavigationLink resource.

Name Type Description
etag

string

A unique read-only string that changes whenever the resource is updated.

id

string

Resource navigation link identifier.

name

string

Name of the resource that is unique within a resource group. This name can be used to access the resource.

properties.link

string

Link to the external resource.

properties.linkedResourceType

string

Resource type of the linked resource.

properties.provisioningState

ProvisioningState

The provisioning state of the resource navigation link resource.

type

string

Resource type.

ResourceNavigationLinksListResult

Response for ResourceNavigationLinks_List operation.

Name Type Description
nextLink

string

The URL to get the next set of results.

value

ResourceNavigationLink[]

The resource navigation links in a subnet.