Get Reserved IP Address

  • Article

 

The Get Reserved IP Address operation retrieves information about the specified reserved IP address.

Request

The Get Reserved IP Address request is specified as follows. Replace <subscription-id> with your subscription ID, and <address-name> with the name of the reserved IP address.

Method

Request URI

GET

https://management.core.windows.net/<subscription-id>/services/networking/reservedips/<address-name>

URI Parameters

None.

Request Headers

The following table describes the request headers.

Request Header

Description

x-ms-version

Required. Specifies the version of the operation to use for this request. This header must be set to 2015-05-01 or higher.

Request Body

None.

Response

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

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

<?xml version="1.0" encoding="utf-8"?>
<ReservedIP xmlns="https://schemas.microsoft.com/windowsazure">
  <Name>name-of-reserved-ip-address</Name>
  <Address>reserved-ip-address</Address>
  <Id>identifier-of-reserved-ip-address</Id>
  <Label>label-of-reserved-ip-address</Label>
  <State>state-of-reserved-ip-address</State>
  <InUse>indicator-of-usage</InUse>
  <ServiceName>name-of-cloud-service</ServiceName>
  <DeploymentName>name-of-deployment</DeploymentName>
  <Location>location-of-reserved-ip-address</Location>
</ReservedIP>

The following table describes the elements in the response body.

Element name

Description

Name

Specifies the name that is assigned to the reserved IP address.

Address

Specifies the IPv4 address that is reserved.

Id

Specifies the unique identifier that was generated for the reserved IP address.

Label

Specifies a label that can be used to identify the reserved IP address. The label can be up to 100 characters long and can be used for your tracking purposes.

State

Specifies the state of the reserved IP address.

Possible values are:

  • Created

  • Creating

  • Updating

  • Deleting

  • Unavailable

InUse

Indicates whether the reserved IP address is being used.

Possible values are:

  • true

  • false

ServiceName

Specifies the name of the cloud service that is associated with the reserved IP address.

DeploymentName

Specifies the name of the deployment that is associated with the reserved IP address.

Location

Specifies the location of the of the reserved IP address. This is the same location as the associated cloud service.