Quota Request Status - List

リファレンス

サービス:: Reserved VM Instances

API バージョン:: 2020-10-25

指定した Azure リージョン (場所)、サブスクリプション、およびリソースプロバイダーについて、過去 1 年間のクォータ要求の履歴を取得します。特定のクォータ要求を選択するには、oData フィルターを使用します。

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Capacity/resourceProviders/{providerId}/locations/{location}/serviceLimitsRequests?api-version=2020-10-25

省略可能なパラメーターを含む:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Capacity/resourceProviders/{providerId}/locations/{location}/serviceLimitsRequests?api-version=2020-10-25&$filter={$filter}&$top={$top}&$skiptoken={$skiptoken}

URI パラメーター

名前

/

必須

型

説明

location

path

True

string

Azure リージョン。

providerId

path

True

string

Azure リソースプロバイダー ID。

subscriptionId

path

True

string

Azure サブスクリプション ID。

api-version

query

True

string

API バージョン。

$filter

query

string

フィールド	サポートされている演算子
requestSubmitTime	ge、le、eq、gt、lt

$skiptoken

query

string

Skiptoken は、前の操作で部分的な結果が返された場合にのみ使用されます。前の応答に nextLink 要素が含まれている場合、nextLink 要素の値には、後続の呼び出しに使用する開始点を指定する skiptoken パラメーターが含まれます。

$top

query

integer (int32)

minimum: 1

返されるレコードの数。

応答

名前	型	説明
200 OK	QuotaRequestDetailsList	わかりました。クォータ要求の詳細と状態を返します。
Other Status Codes	ExceptionResponse	応答のエラーの説明。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

QuotaRequestHistory

要求のサンプル

GET https://management.azure.com/subscriptions/3f75fdf7-977e-44ad-990d-99f14f0f299f/providers/Microsoft.Capacity/resourceProviders/Microsoft.Compute/locations/eastus/serviceLimitsRequests?api-version=2020-10-25


/**
 * Samples for QuotaRequestStatus List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/reservations/resource-manager/Microsoft.Capacity/stable/2020-10-25/examples/getQuotaRequestsHistory
     * .json
     */
    /**
     * Sample code: QuotaRequestHistory.
     * 
     * @param manager Entry point to ReservationsManager.
     */
    public static void quotaRequestHistory(com.azure.resourcemanager.reservations.ReservationsManager manager) {
        manager.quotaRequestStatus().list("3f75fdf7-977e-44ad-990d-99f14f0f299f", "Microsoft.Compute", "eastus", null,
            null, null, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential
from azure.mgmt.reservations import AzureReservationAPI

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-reservations
# USAGE
    python get_quota_requests_history.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = AzureReservationAPI(
        credential=DefaultAzureCredential(),
    )

    response = client.quota_request_status.list(
        subscription_id="3f75fdf7-977e-44ad-990d-99f14f0f299f",
        provider_id="Microsoft.Compute",
        location="eastus",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/reservations/resource-manager/Microsoft.Capacity/stable/2020-10-25/examples/getQuotaRequestsHistory.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armreservations_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/reservations/armreservations/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1e7b408f3323e7f5424745718fe62c7a043a2337/specification/reservations/resource-manager/Microsoft.Capacity/stable/2020-10-25/examples/getQuotaRequestsHistory.json
func ExampleQuotaRequestStatusClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armreservations.NewClientFactory(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewQuotaRequestStatusClient().NewListPager("3f75fdf7-977e-44ad-990d-99f14f0f299f", "Microsoft.Compute", "eastus", &armreservations.QuotaRequestStatusClientListOptions{Filter: nil,
		Top:       nil,
		Skiptoken: nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.QuotaRequestDetailsList = armreservations.QuotaRequestDetailsList{
		// 	Value: []*armreservations.QuotaRequestDetails{
		// 		{
		// 			Name: to.Ptr("00000000-0000-0000-0000-000000000000/2B5C8515-37D8-4B6A-879B-CD641A2CF605"),
		// 			Type: to.Ptr("Microsoft.Capacity/serviceLimitsRequests"),
		// 			ID: to.Ptr("2B5C8515-37D8-4B6A-879B-CD641A2CF605"),
		// 			Properties: &armreservations.QuotaRequestProperties{
		// 				Message: to.Ptr("Request completed"),
		// 				ProvisioningState: to.Ptr(armreservations.QuotaRequestStateSucceeded),
		// 				RequestSubmitTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-08-19T19:23:17.904Z"); return t}()),
		// 				Value: []*armreservations.SubRequest{
		// 					{
		// 						Name: &armreservations.ResourceName{
		// 							LocalizedValue: to.Ptr("Standard HCS Family vCPUs"),
		// 							Value: to.Ptr("standardHCSFamily"),
		// 						},
		// 						Limit: to.Ptr[int32](200),
		// 						Message: to.Ptr("Request completed"),
		// 						ProvisioningState: to.Ptr(armreservations.QuotaRequestStateSucceeded),
		// 						SubRequestID: to.Ptr("AD07450A-DE86-4FD3-859B-107BEF218C4C"),
		// 					},
		// 					{
		// 						Name: &armreservations.ResourceName{
		// 							LocalizedValue: to.Ptr("Standard NC Promo Family vCPUs"),
		// 							Value: to.Ptr("standardNCPromoFamily"),
		// 						},
		// 						Limit: to.Ptr[int32](50),
		// 						Message: to.Ptr("Request completed"),
		// 						ProvisioningState: to.Ptr(armreservations.QuotaRequestStateSucceeded),
		// 						SubRequestID: to.Ptr("AD07450A-DE86-4FD3-859B-107BEF218C4C"),
		// 				}},
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("00000000-0000-0000-0000-000000000000/7E73A85C-83BB-4DE4-903F-076F1A2B91D6"),
		// 			Type: to.Ptr("Microsoft.Capacity/serviceLimitsRequests"),
		// 			ID: to.Ptr("7E73A85C-83BB-4DE4-903F-076F1A2B91D6"),
		// 			Properties: &armreservations.QuotaRequestProperties{
		// 				Message: to.Ptr("Request completed"),
		// 				ProvisioningState: to.Ptr(armreservations.QuotaRequestStateSucceeded),
		// 				RequestSubmitTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-08-18T19:23:17.904Z"); return t}()),
		// 				Value: []*armreservations.SubRequest{
		// 					{
		// 						Name: &armreservations.ResourceName{
		// 							LocalizedValue: to.Ptr("Standard NVSv3 Family vCPUs"),
		// 							Value: to.Ptr("standardNVSv3Family"),
		// 						},
		// 						Limit: to.Ptr[int32](100),
		// 						Message: to.Ptr("Request completed"),
		// 						ProvisioningState: to.Ptr(armreservations.QuotaRequestStateSucceeded),
		// 						SubRequestID: to.Ptr("AD07450A-DE86-4FD3-859B-107BEF218C4C"),
		// 					},
		// 					{
		// 						Name: &armreservations.ResourceName{
		// 							LocalizedValue: to.Ptr("Standard NV Promo Family vCPUs"),
		// 							Value: to.Ptr("standardNVPromoFamily"),
		// 						},
		// 						Limit: to.Ptr[int32](150),
		// 						Message: to.Ptr("Request completed"),
		// 						ProvisioningState: to.Ptr(armreservations.QuotaRequestStateSucceeded),
		// 						SubRequestID: to.Ptr("AD07450A-DE86-4FD3-859B-107BEF218C4C"),
		// 				}},
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("00000000-0000-0000-0000-000000000000/5E460077-AB53-4802-8997-A6940E0B7649"),
		// 			Type: to.Ptr("Microsoft.Capacity/serviceLimitsRequests"),
		// 			ID: to.Ptr("5E460077-AB53-4802-8997-A6940E0B7649"),
		// 			Properties: &armreservations.QuotaRequestProperties{
		// 				Message: to.Ptr("Request completed"),
		// 				ProvisioningState: to.Ptr(armreservations.QuotaRequestStateSucceeded),
		// 				RequestSubmitTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-08-17T19:23:17.904Z"); return t}()),
		// 				Value: []*armreservations.SubRequest{
		// 					{
		// 						Name: &armreservations.ResourceName{
		// 							LocalizedValue: to.Ptr("Standard NC Promo Family vCPUs"),
		// 							Value: to.Ptr("standardNCPromoFamily"),
		// 						},
		// 						Limit: to.Ptr[int32](70),
		// 						Message: to.Ptr("Request completed"),
		// 						ProvisioningState: to.Ptr(armreservations.QuotaRequestStateSucceeded),
		// 						SubRequestID: to.Ptr("AD07450A-DE86-4FD3-859B-107BEF218C4C"),
		// 					},
		// 					{
		// 						Name: &armreservations.ResourceName{
		// 							LocalizedValue: to.Ptr("Standard HBS Family vCPUs"),
		// 							Value: to.Ptr("standardHBSFamily"),
		// 						},
		// 						Limit: to.Ptr[int32](52),
		// 						Message: to.Ptr("Request completed"),
		// 						ProvisioningState: to.Ptr(armreservations.QuotaRequestStateSucceeded),
		// 						SubRequestID: to.Ptr("AD07450A-DE86-4FD3-859B-107BEF218C4C"),
		// 				}},
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { AzureReservationAPI } = require("@azure/arm-reservations");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to For the specified Azure region (location), subscription, and resource provider, get the history of the quota requests for the past year. To select specific quota requests, use the oData filter.
 *
 * @summary For the specified Azure region (location), subscription, and resource provider, get the history of the quota requests for the past year. To select specific quota requests, use the oData filter.
 * x-ms-original-file: specification/reservations/resource-manager/Microsoft.Capacity/stable/2020-10-25/examples/getQuotaRequestsHistory.json
 */
async function quotaRequestHistory() {
  const subscriptionId = "3f75fdf7-977e-44ad-990d-99f14f0f299f";
  const providerId = "Microsoft.Compute";
  const location = "eastus";
  const credential = new DefaultAzureCredential();
  const client = new AzureReservationAPI(credential);
  const resArray = new Array();
  for await (let item of client.quotaRequestStatus.list(subscriptionId, providerId, location)) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Reservations;

// Generated from example definition: specification/reservations/resource-manager/Microsoft.Capacity/stable/2020-10-25/examples/getQuotaRequestsHistory.json
// this example is just showing the usage of "QuotaRequestStatus_List" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "3f75fdf7-977e-44ad-990d-99f14f0f299f";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// get the collection of this QuotaRequestDetailResource
string providerId = "Microsoft.Compute";
AzureLocation location = new AzureLocation("eastus");
QuotaRequestDetailCollection collection = subscriptionResource.GetQuotaRequestDetails(providerId, location);

// invoke the operation and iterate over the result
await foreach (QuotaRequestDetailResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    QuotaRequestDetailData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:: 200

{
  "nextLink": "https://management.azure.com/subscriptions/3f75fdf7-977e-44ad-990d-99f14f0f299f/providers/microsoft.Capacity/resourceProviders/Microsoft.Compute/locations/eastus/serviceLimitsRequests?api-version=2020-10-25&amp;$top=3",
  "value": [
    {
      "id": "2B5C8515-37D8-4B6A-879B-CD641A2CF605",
      "type": "Microsoft.Capacity/serviceLimitsRequests",
      "name": "00000000-0000-0000-0000-000000000000/2B5C8515-37D8-4B6A-879B-CD641A2CF605",
      "properties": {
        "requestSubmitTime": "2019-08-19T19:23:17.904Z",
        "message": "Request completed",
        "provisioningState": "Success",
        "value": [
          {
            "limit": 200,
            "subRequestId": "AD07450A-DE86-4FD3-859B-107BEF218C4C",
            "name": {
              "value": "standardHCSFamily",
              "localizedValue": "Standard HCS Family vCPUs"
            },
            "message": "Request completed",
            "provisioningState": "Success"
          },
          {
            "limit": 50,
            "subRequestId": "AD07450A-DE86-4FD3-859B-107BEF218C4C",
            "name": {
              "value": "standardNCPromoFamily",
              "localizedValue": "Standard NC Promo Family vCPUs"
            },
            "message": "Request completed",
            "provisioningState": "Success"
          }
        ]
      }
    },
    {
      "id": "7E73A85C-83BB-4DE4-903F-076F1A2B91D6",
      "type": "Microsoft.Capacity/serviceLimitsRequests",
      "name": "00000000-0000-0000-0000-000000000000/7E73A85C-83BB-4DE4-903F-076F1A2B91D6",
      "properties": {
        "requestSubmitTime": "2019-08-18T19:23:17.904Z",
        "message": "Request completed",
        "provisioningState": "Succeeded",
        "value": [
          {
            "limit": 100,
            "subRequestId": "AD07450A-DE86-4FD3-859B-107BEF218C4C",
            "name": {
              "value": "standardNVSv3Family",
              "localizedValue": "Standard NVSv3 Family vCPUs"
            },
            "message": "Request completed",
            "provisioningState": "Success"
          },
          {
            "limit": 150,
            "subRequestId": "AD07450A-DE86-4FD3-859B-107BEF218C4C",
            "name": {
              "value": "standardNVPromoFamily",
              "localizedValue": "Standard NV Promo Family vCPUs"
            },
            "message": "Request completed",
            "provisioningState": "Succeeded"
          }
        ]
      }
    },
    {
      "id": "5E460077-AB53-4802-8997-A6940E0B7649",
      "type": "Microsoft.Capacity/serviceLimitsRequests",
      "name": "00000000-0000-0000-0000-000000000000/5E460077-AB53-4802-8997-A6940E0B7649",
      "properties": {
        "requestSubmitTime": "2019-08-17T19:23:17.904Z",
        "message": "Request completed",
        "provisioningState": "Succeeded",
        "value": [
          {
            "limit": 70,
            "subRequestId": "AD07450A-DE86-4FD3-859B-107BEF218C4C",
            "name": {
              "value": "standardNCPromoFamily",
              "localizedValue": "Standard NC Promo Family vCPUs"
            },
            "message": "Request completed",
            "provisioningState": "Succeeded"
          },
          {
            "limit": 52,
            "subRequestId": "AD07450A-DE86-4FD3-859B-107BEF218C4C",
            "name": {
              "value": "standardHBSFamily",
              "localizedValue": "Standard HBS Family vCPUs"
            },
            "message": "Request completed",
            "provisioningState": "Succeeded"
          }
        ]
      }
    }
  ]
}

定義

名前	説明
ExceptionResponse	API エラー。
QuotaRequestDetails	クォータ要求の詳細。
QuotaRequestDetailsList	クォータ要求の詳細。
QuotaRequestState	クォータ要求の状態。
ResourceName	リソースプロバイダーによって提供されるリソース名。 quotaRequest パラメーターには、このプロパティを使用します。
ServiceError	API エラーの詳細。
ServiceErrorDetail	エラーの詳細。
SubRequest	クォータ要求と共に送信されたサブ要求。

ExceptionResponse

Object

API エラー。

名前	型	説明
error	ServiceError	API エラーの詳細。

QuotaRequestDetails

Object

クォータ要求の詳細。

名前	型	説明
id	string	クォータ要求 ID。
name	string	クォータ要求名。
properties.message	string	わかりやすいステータスメッセージ。
properties.provisioningState	QuotaRequestState	クォータ要求の状態。
properties.requestSubmitTime	string (date-time)	ISO 8601 標準で指定されている形式 yyyy-MM-ddTHH:mm:ssZ を使用してクォータ要求が送信された時刻。
properties.value	SubRequest[]	quotaRequests。
type	string	リソースの種類

QuotaRequestDetailsList

Object

クォータ要求の詳細。

名前	型	説明
nextLink	string	クォータ制限の次のページをフェッチする URI。これ以上ページがない場合、これは null です。
value	QuotaRequestDetails[]	クォータ要求。

QuotaRequestState

列挙

クォータ要求の状態。

値	説明
Accepted
Failed
InProgress
Invalid
Succeeded

ResourceName

Object

リソースプロバイダーによって提供されるリソース名。 quotaRequest パラメーターには、このプロパティを使用します。

名前	型	説明
localizedValue	string	リソースにローカライズされた名前が表示されます。
value	string	リソース名。

ServiceError

Object

API エラーの詳細。

名前	型	説明
code	string	エラーコード。
details	ServiceErrorDetail[]	エラーの詳細の一覧。
message	string	エラーメッセージのテキスト。

ServiceErrorDetail

Object

エラーの詳細。

名前	型	説明
code	string	エラーコード。
message	string	エラーメッセージ。

SubRequest

Object

クォータ要求と共に送信されたサブ要求。

名前	型	説明
limit	integer (int32)	クォータ (リソース制限)。
message	string	わかりやすいステータスメッセージ。
name	ResourceName	リソース名。
provisioningState	QuotaRequestState	クォータ要求の状態。
resourceType	string	クォータチェックが行われたリソースの種類。
subRequestId	string	個々の要求のサブ要求 ID。
unit	string	カウントやバイトなどの制限単位。 GET クォータ操作の応答で指定されたユニットフィールドを使用します。