Getting Subnet by Name

You can get information about a subnet with the specified name within a virtual network with the specified name.

Request

GET https://<hostname>:4443/v6/AzureServiceAccounts/{serviceAccountId}/Subscriptions/{subscriptionId}/ResourceGroups/{resourceGroupName}/VirtualNetworks/{virtualNetworkName}/Subnets/{subnetName}

Request Headers

The request header must contain an authorization token of the current session.

Request Parameters

The following parameters must be specified in the URL of the request:

Parameter

Type

Description

serviceAccountId

string

Specifies the identification number of Microsoft Azure service account. For more information on how to get this parameter, see Getting Azure Service Accounts.

subscriptionId

string

Specifies the Microsoft Azure subscription ID. For more information on how to get this parameter, see Getting Subscriptions.

resourceGroupName

string

Specifies the resource group name. For more information on how to get this parameter, see Getting Resource Groups.

virtualNetworkName

string

Specifies the virtual network name. For more information on how to get this parameter, see Getting Virtual Networks.

subnetName

string

Specifies the subnet name. For more information on how to get this parameter, see Getting Subnets.

Request Body

None.

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns a response code 200 OK.

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTPS headers.

Header

Description

Content-length

The length of the response body.

Content-type

The media type and syntax of the response body message: application/json; charset=utf-8

Response Body

The response body contains the following properties:

Property

Type

Description

name

string

Specifies the subnet name.

addressPrefix

string

Specifies a range of IPv4 addresses for the subnet.

Example

The example shows how to get information about the default subnet within the groupvnet775 virtual network.

Request:

GET https://abc.tech.local:4443/v6/AzureServiceAccounts/576705c3-a1af-49bd-878f-9067865bfcf9/Subscriptions/be7051ea-8fa4-4605-c607-89f3dd09fffd/ResourceGroups/ResourceGroup10/VirtualNetworks/groupvnet775/Subnets/default

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

{

 "name": "default",

 "addressPrefix": "10.5.0.0/24"

}