Create Reserved IP Address
The Create Reserved IP Address operation reserves an IPv4 address for the specified subscription. You can use a small number of reserved IP addresses for free, but unused reserved IP addresses and a number of addresses above the limit will incur charges.
Request
The Create Reserved IP Address request is specified as follows. Replace <subscription-id> with the subscription ID.
Method |
Request URI |
---|---|
POST |
https://management.core.windows.net/<subscription-id>/services/networking/reservedips |
URI Parameters
None.
Request Headers
The following table describes the request headers.
Request Header |
Description |
---|---|
Content-Type |
Required. Set this header to application/xml. |
x-ms-version |
Required. Specifies the version of the operation to use for this request. The value of this header must be set to 2014-05-01 or higher. |
Request Body
<?xml version="1.0" encoding="utf-8"?>
<ReservedIP xmlns="https://schemas.microsoft.com/windowsazure">
<Name>name-of-reserved-ip-address</Name>
<Label>label-of-reserved-ip-address</Label>
<Location>location-of-cloud-service</Location>
</ReservedIP>
The following table describes the elements of the request body.
Element Name |
Description |
Name |
Required. Specifies the name for the reserved IP address. |
Label |
Optional. Specifies a label for the reserved IP address. The label can be up to 100 characters long and can be used for your tracking purposes. |
Location |
Required. Specifies the location of the reserved IP address. This should be the same location that is assigned to the cloud service containing the deployment that will use the reserved IP address. |
Response
The response includes an HTTP status code and a set of response headers.
Status Code
A successful operation returns status code 202 (Accepted).
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. For an asynchronous operation, you can call Get Operation Status with the value of the header to determine whether the operation is complete, has failed, or is still in progress. |
Response Body
None.
Remarks
Unused reserved IP addresses continue to incur a slight charge.