Get Network Security Group for Subnet

 

The Get Network Security Group for Subnet operation returns information about the network security group associated with a subnet.

Request

The Get Network Security Group for Subnet request may be specified as follows. Replace <subscription-id> with the subscription ID and <subnet-name> with the name of the subnet.

Method

Request URI

GET

https://management.core.windows.net/<subscription-id>/services/virtualnetwork/<virtual-network-name>/subnets/<subnet-name>/networksecuritygroups

URI Parameters

URI Parameter

Description

detaillevel=Full

Optional. Specifies that the rules for the network security group should be returned.

Request Headers

The following table describes the request headers.

Request Header

Description

Content-Type

Required. Specifies that the the type of the request content. The value should be set to application/xml.

x-ms-version

Required. Specifies the version of the operation to use for this request. The value for this header should be set to 2014-10-01 or higher.

Request Body

None.

Response

The response includes an HTTP status code, a response body, and a set of response headers.

Status Code

A successful operation returns status code 200 (OK).

Response Headers

The response for this operation includes the following headers. The response may also include additional standard HTTP headers.

Response Header

Description

x-ms-request-id

A value that uniquely identifies a request made against the management service.

Response Body

<NetworkSecurityGroup xmlns="https://schemas.microsoft.com/windowsazure"
xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Name>network-security-group-name</Name>
  <State>association-state</State>
</NetworkSecurityGroup>

The following table describes the elements in the response body.

Element name

Description

Name

Specifies the name of the security group.

State

Specifies the state of the association between the network security group and the subnet.

Possible values are:

  • Created

  • Creating

  • Updating

  • Deleting

  • Unavailable