Microsoft REST API

https://learn.microsoft.com/en-us/rest/api/
Admin
This project provides comprehensive documentation and guides for interacting with Microsoft's REST...
Tokens:2,897
Snippets:40
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Azure Resource Manager GET Response Body Example (Subscriptions)

Source: https://learn.microsoft.com/en-us/rest/api/azure

Example of a JSON response body for a GET request to the Azure Resource Manager, listing Azure subscriptions.

```JSON
{
    "value":[
        {
        "id":"/subscriptions/",
        "subscriptionId":"...",
        "displayName":"My Azure Subscription",
        "state":"Enabled",

"subscriptionPolicies":{
            "locationPlacementId":"Public_2015-09-01",
            "quotaId":"MSDN_2014-05-01",
            "spendingLimit":"On"}
        }
    ]
}


```

--------------------------------

### Azure Resource Manager GET Request Example

Source: https://learn.microsoft.com/en-us/rest/api/azure

Example of an HTTPS GET request to the Azure Resource Manager for retrieving subscriptions. The request includes necessary headers but has an empty body.

```HTTP
GET /subscriptions?api-version=2014-04-01-preview HTTP/1.1
Authorization: Bearer <bearer-token>
Host: management.azure.com

<no body>


```

--------------------------------

### Azure Resource Manager GET Response Header Example

Source: https://learn.microsoft.com/en-us/rest/api/azure

Example of a successful HTTP response header for a GET request to the Azure Resource Manager, indicating a 200 OK status.

```HTTP
HTTP/1.1 200 OK
Content-Length: 303
Content-Type: application/json;


```

--------------------------------

### Send GET Request to List Subscriptions

Source: https://learn.microsoft.com/en-us/rest/api/azure

Example of sending an HTTPS GET request to the /subscriptions endpoint to retrieve a list of subscriptions for a user. This includes the necessary headers and an empty body.

```APIDOC
## GET /subscriptions

### Description
Retrieves a list of subscriptions for the authenticated user.

### Method
GET

### Endpoint
/subscriptions?api-version=2014-04-01-preview

### Parameters
#### Query Parameters
- **api-version** (string) - Required - Specifies the API version to use for the request.

#### Request Body
- **(empty)**

### Response
#### Success Response (200)
- **value** (array) - Contains a list of Azure subscriptions and their properties.
  - **id** (string) - The unique identifier for the subscription.
  - **subscriptionId** (string) - The ID of the subscription.
  - **displayName** (string) - The display name of the subscription.
  - **state** (string) - The current state of the subscription (e.g., "Enabled").
  - **subscriptionPolicies** (object) - Policies associated with the subscription.
    - **locationPlacementId** (string) - The location placement ID.
    - **quotaId** (string) - The quota ID.
    - **spendingLimit** (string) - The spending limit status.

### Response Example
```json
{
    "value":[
        {
        "id":"/subscriptions/...",
        "subscriptionId":"...",
        "displayName":"My Azure Subscription",
        "state":"Enabled",
        "subscriptionPolicies":{
            "locationPlacementId":"Public_2015-09-01",
            "quotaId":"MSDN_2014-05-01",
            "spendingLimit":"On"}
        }
    ]
}
```
```

--------------------------------

### Azure Resource Manager PUT Response Header Example

Source: https://learn.microsoft.com/en-us/rest/api/azure

Example of a successful HTTP response header for a PUT request to the Azure Resource Manager, confirming the operation.

```HTTP
HTTP/1.1 200 OK
Content-Length: 193
Content-Type: application/json;


```

--------------------------------

### Example JSON Request Body

Source: https://learn.microsoft.com/en-us/rest/api/azure

This is an example of a JSON formatted request body, typically used when the Content-Type header is set to 'application/json'.

```json
{
  "<name>": "<value>"
}
```

--------------------------------

### Azure Resource Manager PUT Request Example

Source: https://learn.microsoft.com/en-us/rest/api/azure

Example of an HTTPS PUT request to the Azure Resource Manager for creating or updating a resource group. Includes request headers and a JSON body.

```HTTP
PUT /subscriptions/.../resourcegroups/ExampleResourceGroup?api-version=2016-02-01  HTTP/1.1
Authorization: Bearer <bearer-token>
Content-Length: 29
Content-Type: application/json
Host: management.azure.com

{
  "location": "West US"
}


```

--------------------------------

### Azure Resource Manager PUT Response Body Example (Resource Group)

Source: https://learn.microsoft.com/en-us/rest/api/azure

Example of a JSON response body for a PUT request to the Azure Resource Manager, confirming the creation of a resource group.

```JSON
{
    "id":"/subscriptions/.../resourceGroups/ExampleResourceGroup",
    "name":"ExampleResourceGroup",
    "location":"westus",
    "properties":
        {
        "provisioningState":"Succeeded"
        }
}


```

--------------------------------

### Send PUT Request to Create Resource Group

Source: https://learn.microsoft.com/en-us/rest/api/azure

Example of sending an HTTPS PUT request to create or update an Azure Resource Group. This includes request headers and a JSON request body.

```APIDOC
## PUT /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}

### Description
Creates or updates an Azure Resource Group.

### Method
PUT

### Endpoint
/subscriptions/.../resourcegroups/ExampleResourceGroup?api-version=2016-02-01

### Parameters
#### Path Parameters
- **resourceGroupName** (string) - Required - The name of the resource group to create or update.

#### Query Parameters
- **api-version** (string) - Required - Specifies the API version to use for the request.

#### Request Body
- **location** (string) - Required - The Azure region where the resource group will be created or updated.

### Request Example
```json
{
  "location": "West US"
}
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the resource group.
- **name** (string) - The name of the resource group.
- **location** (string) - The Azure region of the resource group.
- **properties** (object) - Properties of the resource group.
  - **provisioningState** (string) - The provisioning state of the resource group (e.g., "Succeeded").

### Response Example
```json
{
    "id":"/subscriptions/.../resourceGroups/ExampleResourceGroup",
    "name":"ExampleResourceGroup",
    "location":"westus",
    "properties":
        {
        "provisioningState":"Succeeded"
        }
}
```
```

--------------------------------

### Azure REST API Paging Response Structure

Source: https://learn.microsoft.com/en-us/rest/api/azure

This JSON structure illustrates how Azure REST APIs return paginated results. The 'nextLink' property contains a URL to retrieve the subsequent set of items when the result set exceeds the maximum number of items per response.

```json
{
  "value": [
    <returned-items>
  ],
  "nextLink": "https://management.azure.com/{operation}?api-version={version}&%24skiptoken={token}"
}
```
Tokens:
Raw