Microsoft.Management (preview:2025-03-15)

2025/03/25 • 25 new methods

GroupQuotas_CreateOrUpdate (new)
Description :  Creates a new GroupQuota for the name passed. A RequestId will be returned by the Service. The status can be polled periodically. The status Async polling is using standards defined at - https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/async-api-reference.md#asynchronous-operations. Use the OperationsStatus URI provided in Azure-AsyncOperation header, the duration will be specified in retry-after header. Once the operation gets to terminal state - Succeeded | Failed, then the URI will change to Get URI and full details can be checked.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}
{
managementGroupId:
{
Description: Management Group Id. ,
Required: True ,
}
string ,
groupQuotaName:
{
Description: The GroupQuota name. The name should be unique for the provided context tenantId/MgId. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
GroupQuotaPutRequestBody:
{
Description: The GroupQuota body details for creation or update of a GroupQuota entity. ,
Required: False ,
}
object ,
}

⚐ Response (200)

{
$schema:
{
Description: Properties and filters for ShareQuota. The request parameter is optional, if there are no filters specified. ,
}
object ,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation. ,
}
integer ,
location:
{
Description: URL for determining when an operation has completed. Send a GET request to the URL in Location header. The URI should return a 202 until the operation reaches a terminal state and 200 once it reaches a terminal state. For more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#202-accepted-and-location-headers. New guidelines - https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#131-resource-based-long-running-operations-relo ,
}
string ,
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. To get the status of the asynchronous operation, send a GET request to the URL in Azure-AsyncOperation header value. For more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#asynchronous-operations ,
}
string ,
}
,
$schema:
{
Description: The provisioning state for the operation. ,
}
{
properties:
{
Required: False ,
}
{
provisioningState:
{
Description: Request status. ,
Enum:
{
Accepted: No description available. ,
Created: No description available. ,
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
InProgress: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GroupQuotas_Update (new)
Description :  Updates the GroupQuotas for the name passed. A GroupQuotas RequestId will be returned by the Service. The status can be polled periodically. The status Async polling is using standards defined at - https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/async-api-reference.md#asynchronous-operations. Use the OperationsStatus URI provided in Azure-AsyncOperation header, the duration will be specified in retry-after header. Once the operation gets to terminal state - Succeeded | Failed, then the URI will change to Get URI and full details can be checked. Any change in the filters will be applicable to the future quota assignments, existing quota allocated to subscriptions from the GroupQuotas remains unchanged.
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}
{
managementGroupId:
{
Description: Management Group Id. ,
Required: True ,
}
string ,
groupQuotaName:
{
Description: The GroupQuota name. The name should be unique for the provided context tenantId/MgId. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
GroupQuotasPatchRequestBody:
{
Description: The GroupQuotas Patch Request. ,
Required: False ,
}
{
properties:
{
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
$schema:
{
Description: Properties and filters for ShareQuota. The request parameter is optional, if there are no filters specified. ,
}
object ,
}

⚐ Response (202)

{
retry-after:
{
Description: The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation. ,
}
integer ,
location:
{
Description: URL for determining when an operation has completed. Send a GET request to the URL in Location header. The URI should return a 202 until the operation reaches a terminal state and 200 once it reaches a terminal state. For more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#202-accepted-and-location-headers ,
}
string ,
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. To get the status of the asynchronous operation, send a GET request to the URL in Azure-AsyncOperation header value. For more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#asynchronous-operations ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GroupQuotas_Get (new)
Description :  Gets the GroupQuotas for the name passed. It will return the GroupQuotas properties only. The details on group quota can be access from the group quota APIs.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}
{
managementGroupId:
{
Description: Management Group Id. ,
Required: True ,
}
string ,
groupQuotaName:
{
Description: The GroupQuota name. The name should be unique for the provided context tenantId/MgId. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: Properties and filters for ShareQuota. The request parameter is optional, if there are no filters specified. ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GroupQuotas_Delete (new)
Description :  Deletes the GroupQuotas for the name passed. All the remaining shareQuota in the GroupQuotas will be lost.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}
{
managementGroupId:
{
Description: Management Group Id. ,
Required: True ,
}
string ,
groupQuotaName:
{
Description: The GroupQuota name. The name should be unique for the provided context tenantId/MgId. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
retry-after:
{
Description: The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation. ,
}
integer ,
location:
{
Description: URL for determining when an operation has completed. Send a GET request to the URL in Location header. The URI should return a 202 until the operation reaches a terminal state and 200 once it reaches a terminal state. For more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#202-accepted-and-location-headers ,
}
string ,
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. To get the status of the asynchronous operation, send a GET request to the URL in Azure-AsyncOperation header value. For more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#asynchronous-operations ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GroupQuotas_List (new)
Description :  Lists GroupQuotas for the scope passed. It will return the GroupQuotas QuotaEntity properties only.The details on group quota can be access from the group quota APIs.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas
{
managementGroupId:
{
Description: Management Group Id. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Group Quotas at MG level. ,
Required: False ,
}
[
object ,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GroupQuotaSubscriptions_CreateOrUpdate (new)
Description :  Adds a subscription to GroupQuotas. The subscriptions will be validated based on the additionalAttributes defined in the GroupQuota. The additionalAttributes works as filter for the subscriptions, which can be included in the GroupQuotas. The request's TenantId is validated against the subscription's TenantId.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/subscriptions/{subscriptionId}
{
managementGroupId:
{
Description: Management Group Id. ,
Required: True ,
}
string ,
groupQuotaName:
{
Description: The GroupQuota name. The name should be unique for the provided context tenantId/MgId. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
subscriptionId:
{
Description: An Azure subscriptionId. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Status of this subscriptionId being associated with the GroupQuotasEntity. ,
Enum:
{
Accepted: No description available. ,
Created: No description available. ,
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
InProgress: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation. ,
}
integer ,
location:
{
Description: URL for determining when an operation has completed. Send a GET request to the URL in Location header. The URI should return a 202 until the operation reaches a terminal state and 200 once it reaches a terminal state. For more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#202-accepted-and-location-headers. New guidelines - https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#131-resource-based-long-running-operations-relo ,
}
string ,
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. To get the status of the asynchronous operation, send a GET request to the URL in Azure-AsyncOperation header value. For more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#asynchronous-operations ,
}
string ,
}
,
$schema:
{
Description: The provisioning state for the operation. ,
}
{
properties:
{
Required: False ,
}
{
provisioningState:
{
Description: Request status. ,
Enum:
{
Accepted: No description available. ,
Created: No description available. ,
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
InProgress: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GroupQuotaSubscriptions_Update (new)
Description :  Updates the GroupQuotas with the subscription to add to the subscriptions list. The subscriptions will be validated if additionalAttributes are defined in the GroupQuota. The request's TenantId is validated against the subscription's TenantId.
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/subscriptions/{subscriptionId}
{
managementGroupId:
{
Description: Management Group Id. ,
Required: True ,
}
string ,
groupQuotaName:
{
Description: The GroupQuota name. The name should be unique for the provided context tenantId/MgId. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
subscriptionId:
{
Description: An Azure subscriptionId. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Status of this subscriptionId being associated with the GroupQuotasEntity. ,
Enum:
{
Accepted: No description available. ,
Created: No description available. ,
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
InProgress: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
retry-after:
{
Description: The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation. ,
}
integer ,
location:
{
Description: URL for determining when an operation has completed. Send a GET request to the URL in Location header. The URI should return a 202 until the operation reaches a terminal state and 200 once it reaches a terminal state. For more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#202-accepted-and-location-headers ,
}
string ,
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. To get the status of the asynchronous operation, send a GET request to the URL in Azure-AsyncOperation header value. For more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#asynchronous-operations ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GroupQuotaSubscriptions_Delete (new)
Description :  Removes the subscription from GroupQuotas. The request's TenantId is validated against the subscription's TenantId.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/subscriptions/{subscriptionId}
{
managementGroupId:
{
Description: Management Group Id. ,
Required: True ,
}
string ,
groupQuotaName:
{
Description: The GroupQuota name. The name should be unique for the provided context tenantId/MgId. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
retry-after:
{
Description: The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation. ,
}
integer ,
location:
{
Description: URL for determining when an operation has completed. Send a GET request to the URL in Location header. The URI should return a 202 until the operation reaches a terminal state and 200 once it reaches a terminal state. For more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#202-accepted-and-location-headers ,
}
string ,
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. To get the status of the asynchronous operation, send a GET request to the URL in Azure-AsyncOperation header value. For more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#asynchronous-operations ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GroupQuotaSubscriptions_Get (new)
Description :  Returns the subscriptionIds along with its provisioning state for being associated with the GroupQuota. If the subscription is not a member of GroupQuota, it will return 404, else 200.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/subscriptions/{subscriptionId}
{
managementGroupId:
{
Description: Management Group Id. ,
Required: True ,
}
string ,
groupQuotaName:
{
Description: The GroupQuota name. The name should be unique for the provided context tenantId/MgId. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
subscriptionId:
{
Description: An Azure subscriptionId. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Status of this subscriptionId being associated with the GroupQuotasEntity. ,
Enum:
{
Accepted: No description available. ,
Created: No description available. ,
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
InProgress: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GroupQuotaSubscriptions_List (new)
Description :  Returns a list of the subscriptionIds associated with the GroupQuotas.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/subscriptions
{
managementGroupId:
{
Description: Management Group Id. ,
Required: True ,
}
string ,
groupQuotaName:
{
Description: The GroupQuota name. The name should be unique for the provided context tenantId/MgId. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of GroupQuotaSubscriptionIds ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
subscriptionId:
{
Description: An Azure subscriptionId. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Status of this subscriptionId being associated with the GroupQuotasEntity. ,
Enum:
{
Accepted: No description available. ,
Created: No description available. ,
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
InProgress: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GroupQuotaSubscriptionRequests_List (new)
Description :  List API to check the status of a subscriptionId requests by requestId. Request history is maintained for 1 year.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/subscriptionRequests
{
managementGroupId:
{
Description: Management Group Id. ,
Required: True ,
}
string ,
groupQuotaName:
{
Description: The GroupQuota name. The name should be unique for the provided context tenantId/MgId. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of GroupQuotaSubscriptionRequests Status ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
subscriptionId:
{
Description: The subscription Id ,
Required: False ,
}
string ,
requestSubmitTime:
{
Description: The request submission time. The date conforms to the following format specified by the ISO 8601 standard: yyyy-MM-ddTHH:mm:ssZ ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Status of this subscriptionId being associated with the GroupQuotasEntity. ,
Enum:
{
Accepted: No description available. ,
Created: No description available. ,
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
InProgress: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GroupQuotaSubscriptionRequests_Get (new)
Description :  Get API to check the status of a subscriptionIds request by requestId. Use the polling API - OperationsStatus URI specified in Azure-AsyncOperation header field, with retry-after duration in seconds to check the intermediate status. This API provides the finals status with the request details and status.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/subscriptionRequests/{requestId}
{
managementGroupId:
{
Description: Management Group Id. ,
Required: True ,
}
string ,
groupQuotaName:
{
Description: The GroupQuota name. The name should be unique for the provided context tenantId/MgId. ,
Required: True ,
}
string ,
requestId:
{
Description: Request Id. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
subscriptionId:
{
Description: The subscription Id ,
Required: False ,
}
string ,
requestSubmitTime:
{
Description: The request submission time. The date conforms to the following format specified by the ISO 8601 standard: yyyy-MM-ddTHH:mm:ssZ ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Status of this subscriptionId being associated with the GroupQuotasEntity. ,
Enum:
{
Accepted: No description available. ,
Created: No description available. ,
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
InProgress: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GroupQuotaLimitsRequest_Update (new)
Description :  Create the GroupQuota requests for a specific ResourceProvider/Location/Resource. The resourceName properties are specified in the request body. Only 1 resource quota can be requested. Please note that patch request creates a new groupQuota request. Use the polling API - OperationsStatus URI specified in Azure-AsyncOperation header field, with retry-after duration in seconds to check the intermediate status. This API provides the finals status with the request details and status.
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/resourceProviders/{resourceProviderName}/groupQuotaLimits/{location}
{
managementGroupId:
{
Description: Management Group Id. ,
Required: True ,
}
string ,
groupQuotaName:
{
Description: The GroupQuota name. The name should be unique for the provided context tenantId/MgId. ,
Required: True ,
}
string ,
resourceProviderName:
{
Description: The resource provider name, such as - Microsoft.Compute. Currently only Microsoft.Compute resource provider supports this API. ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
groupQuotaRequest:
{
Description: The GroupQuotaRequest body details for specific resourceProvider/location/resources. ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
provisioningState:
{
Description: Request status. ,
Enum:
{
Accepted: No description available. ,
Created: No description available. ,
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
InProgress: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: List of Group Quota Limit details. ,
Required: False ,
}
[
{
properties:
{
Description: Group Quota properties for the specified resource. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
provisioningState:
{
Description: Request status. ,
Enum:
{
Accepted: No description available. ,
Created: No description available. ,
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
InProgress: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: List of Group Quota Limit details. ,
Required: False ,
}
[
{
properties:
{
Description: Group Quota properties for the specified resource. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
retry-after:
{
Description: The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation. ,
}
integer ,
location:
{
Description: URL for determining when an operation has completed. Send a GET request to the URL in Location header. The URI should return a 202 until the operation reaches a terminal state and 200 once it reaches a terminal state. For more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#202-accepted-and-location-headers. New guidelines - https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#131-resource-based-long-running-operations-relo ,
}
string ,
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. To get the status of the asynchronous operation, send a GET request to the URL in Azure-AsyncOperation header value. For more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#asynchronous-operations ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GroupQuotaLimits_List (new)
Description :  Gets the GroupQuotaLimits for the specified resource provider and location for resource names passed in $filter=resourceName eq {SKU}.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/resourceProviders/{resourceProviderName}/groupQuotaLimits/{location}
{
managementGroupId:
{
Description: Management Group Id. ,
Required: True ,
}
string ,
groupQuotaName:
{
Description: The GroupQuota name. The name should be unique for the provided context tenantId/MgId. ,
Required: True ,
}
string ,
resourceProviderName:
{
Description: The resource provider name, such as - Microsoft.Compute. Currently only Microsoft.Compute resource provider supports this API. ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
provisioningState:
{
Description: Request status. ,
Enum:
{
Accepted: No description available. ,
Created: No description available. ,
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
InProgress: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: List of Group Quota Limit details. ,
Required: False ,
}
[
{
properties:
{
Description: Group Quota properties for the specified resource. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GroupQuotaLimitsRequest_Get (new)
Description :  Get API to check the status of a GroupQuota request by requestId.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/groupQuotaRequests/{requestId}
{
managementGroupId:
{
Description: Management Group Id. ,
Required: True ,
}
string ,
groupQuotaName:
{
Description: The GroupQuota name. The name should be unique for the provided context tenantId/MgId. ,
Required: True ,
}
string ,
requestId:
{
Description: Request Id. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
requestedResource:
{
Description: Requested Resource. ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
limit:
{
Description: The new quota limit for the subscription. The incremental quota will be allocated from pre-approved group quota. ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: Name of the resource provided by the resource provider. This property is already included in the request URI, so it is a readonly property returned in the response. ,
Required: False ,
}
{
value:
{
Description: Resource name. ,
Required: False ,
}
string ,
localizedValue:
{
Description: Resource display name. ,
Required: False ,
}
string ,
}
,
region:
{
Description: Location/Azure region for the quota requested for resource. ,
Required: False ,
}
string ,
comments:
{
Description: GroupQuota Request comments and details for request. This is optional paramter to provide more details related to the requested resource. ,
Required: False ,
}
string ,
}
,
}
,
requestSubmitTime:
{
Description: The request submission time. The date conforms to the following format specified by the ISO 8601 standard: yyyy-MM-ddTHH:mm:ssZ ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Request status. ,
Enum:
{
Accepted: No description available. ,
Created: No description available. ,
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
InProgress: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
faultCode:
{
Description: Details of the failure. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GroupQuotaLimitsRequest_List (new)
Description :  Get API to check the status of a GroupQuota request by requestId.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/resourceProviders/{resourceProviderName}/groupQuotaRequests
{
managementGroupId:
{
Description: Management Group Id. ,
Required: True ,
}
string ,
groupQuotaName:
{
Description: The GroupQuota name. The name should be unique for the provided context tenantId/MgId. ,
Required: True ,
}
string ,
resourceProviderName:
{
Description: The resource provider name, such as - Microsoft.Compute. Currently only Microsoft.Compute resource provider supports this API. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Supported operators |---------------------|------------------------ location eq {location} and resource eq {resourceName} Example: $filter=location eq eastus and resourceName eq cores ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Subscription groupQuotaRequests list. ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
requestedResource:
{
Description: Requested Resource. ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
limit:
{
Description: The new quota limit for the subscription. The incremental quota will be allocated from pre-approved group quota. ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: Name of the resource provided by the resource provider. This property is already included in the request URI, so it is a readonly property returned in the response. ,
Required: False ,
}
{
value:
{
Description: Resource name. ,
Required: False ,
}
string ,
localizedValue:
{
Description: Resource display name. ,
Required: False ,
}
string ,
}
,
region:
{
Description: Location/Azure region for the quota requested for resource. ,
Required: False ,
}
string ,
comments:
{
Description: GroupQuota Request comments and details for request. This is optional paramter to provide more details related to the requested resource. ,
Required: False ,
}
string ,
}
,
}
,
requestSubmitTime:
{
Description: The request submission time. The date conforms to the following format specified by the ISO 8601 standard: yyyy-MM-ddTHH:mm:ssZ ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Request status. ,
Enum:
{
Accepted: No description available. ,
Created: No description available. ,
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
InProgress: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
faultCode:
{
Description: Details of the failure. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GroupQuotaSubscriptionAllocationRequest_Update (new)
Description :  Request to assign quota from group quota to a specific Subscription. The assign GroupQuota to subscriptions or reduce the quota allocated to subscription to give back the unused quota ( quota >= usages) to the groupQuota. So, this API can be used to assign Quota to subscriptions and assign back unused quota to group quota, which can be assigned to another subscriptions in the GroupQuota. User can collect unused quotas from multiple subscriptions within the groupQuota and assign the groupQuota to the subscription, where it's needed.
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/subscriptions/{subscriptionId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/resourceProviders/{resourceProviderName}/quotaAllocations/{location}
{
managementGroupId:
{
Description: Management Group Id. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
groupQuotaName:
{
Description: The GroupQuota name. The name should be unique for the provided context tenantId/MgId. ,
Required: True ,
}
string ,
resourceProviderName:
{
Description: The resource provider name, such as - Microsoft.Compute. Currently only Microsoft.Compute resource provider supports this API. ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
allocateQuotaRequest:
{
Description: Quota requests payload. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
provisioningState:
{
Description: Request status. ,
Enum:
{
Accepted: No description available. ,
Created: No description available. ,
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
InProgress: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Subscription quota list. ,
Required: False ,
}
[
{
properties:
{
Description: Quota properties for the specified resource. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
provisioningState:
{
Description: Request status. ,
Enum:
{
Accepted: No description available. ,
Created: No description available. ,
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
InProgress: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Subscription quota list. ,
Required: False ,
}
[
{
properties:
{
Description: Quota properties for the specified resource. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
retry-after:
{
Description: The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation. ,
}
integer ,
location:
{
Description: URL for determining when an operation has completed. Send a GET request to the URL in Location header. The URI should return a 202 until the operation reaches a terminal state and 200 once it reaches a terminal state. For more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#202-accepted-and-location-headers ,
}
string ,
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. To get the status of the asynchronous operation, send a GET request to the URL in Azure-AsyncOperation header value. For more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#asynchronous-operations ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GroupQuotaSubscriptionAllocation_List (new)
Description :  Gets all the quota allocated to a subscription for the specified resource provider and location for resource names passed in $filter=resourceName eq {SKU}. This will include the GroupQuota and total quota allocated to the subscription. Only the Group quota allocated to the subscription can be allocated back to the MG Group Quota.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/subscriptions/{subscriptionId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/resourceProviders/{resourceProviderName}/quotaAllocations/{location}
{
managementGroupId:
{
Description: Management Group Id. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
groupQuotaName:
{
Description: The GroupQuota name. The name should be unique for the provided context tenantId/MgId. ,
Required: True ,
}
string ,
resourceProviderName:
{
Description: The resource provider name, such as - Microsoft.Compute. Currently only Microsoft.Compute resource provider supports this API. ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
provisioningState:
{
Description: Request status. ,
Enum:
{
Accepted: No description available. ,
Created: No description available. ,
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
InProgress: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Subscription quota list. ,
Required: False ,
}
[
{
properties:
{
Description: Quota properties for the specified resource. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GroupQuotaSubscriptionAllocationRequest_Get (new)
Description :  Get the quota allocation request status for the subscriptionId by allocationId.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/subscriptions/{subscriptionId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/resourceProviders/{resourceProviderName}/quotaAllocationRequests/{allocationId}
{
managementGroupId:
{
Description: Management Group Id. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
groupQuotaName:
{
Description: The GroupQuota name. The name should be unique for the provided context tenantId/MgId. ,
Required: True ,
}
string ,
resourceProviderName:
{
Description: The resource provider name, such as - Microsoft.Compute. Currently only Microsoft.Compute resource provider supports this API. ,
Required: True ,
}
string ,
allocationId:
{
Description: Request Id. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
requestedResource:
{
Description: The new quota request allocated to subscription. ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
limit:
{
Description: The new quota limit for the subscription. The incremental quota will be allocated from pre-approved group quota. ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: Name of the resource provided by the resource provider. This property is already included in the request URI, so it is a readonly property returned in the response. ,
Required: False ,
}
{
value:
{
Description: Resource name. ,
Required: False ,
}
string ,
localizedValue:
{
Description: Resource display name. ,
Required: False ,
}
string ,
}
,
region:
{
Description: The location for which the subscription is allocated ,
Required: False ,
}
string ,
}
,
}
,
requestSubmitTime:
{
Description: The request submission time. The date conforms to the following format specified by the ISO 8601 standard: yyyy-MM-ddTHH:mm:ssZ ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Request status. ,
Enum:
{
Accepted: No description available. ,
Created: No description available. ,
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
InProgress: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
faultCode:
{
Description: Details of the failure. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GroupQuotaSubscriptionAllocationRequest_List (new)
Description :  Get all the quotaAllocationRequests for a resourceProvider/location. The filter paramter for location is required.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/subscriptions/{subscriptionId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/resourceProviders/{resourceProviderName}/quotaAllocationRequests
{
managementGroupId:
{
Description: Management Group Id. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
groupQuotaName:
{
Description: The GroupQuota name. The name should be unique for the provided context tenantId/MgId. ,
Required: True ,
}
string ,
resourceProviderName:
{
Description: The resource provider name, such as - Microsoft.Compute. Currently only Microsoft.Compute resource provider supports this API. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Supported operators |---------------------|------------------------ location eq {location} Example: $filter=location eq eastus ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of QuotaAllocation Request Status ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
requestedResource:
{
Description: The new quota request allocated to subscription. ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
limit:
{
Description: The new quota limit for the subscription. The incremental quota will be allocated from pre-approved group quota. ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: Name of the resource provided by the resource provider. This property is already included in the request URI, so it is a readonly property returned in the response. ,
Required: False ,
}
{
value:
{
Description: Resource name. ,
Required: False ,
}
string ,
localizedValue:
{
Description: Resource display name. ,
Required: False ,
}
string ,
}
,
region:
{
Description: The location for which the subscription is allocated ,
Required: False ,
}
string ,
}
,
}
,
requestSubmitTime:
{
Description: The request submission time. The date conforms to the following format specified by the ISO 8601 standard: yyyy-MM-ddTHH:mm:ssZ ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Request status. ,
Enum:
{
Accepted: No description available. ,
Created: No description available. ,
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
InProgress: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
faultCode:
{
Description: Details of the failure. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GroupQuotaUsages_List (new)
Description :  Gets the GroupQuotas usages and limits(quota). Location is required paramter.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/resourceProviders/{resourceProviderName}/locationUsages/{location}
{
managementGroupId:
{
Description: Management Group Id. ,
Required: True ,
}
string ,
groupQuotaName:
{
Description: The GroupQuota name. The name should be unique for the provided context tenantId/MgId. ,
Required: True ,
}
string ,
resourceProviderName:
{
Description: The resource provider name, such as - Microsoft.Compute. Currently only Microsoft.Compute resource provider supports this API. ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of resource usages at Group Quotas. ,
Required: False ,
}
[
{
properties:
{
Description: Resource details with usages and GroupQuota. ,
Required: False ,
}
{
name:
{
Description: Name of the resource provided by the resource provider. This property is already included in the request URI, so it is a readonly property returned in the response. ,
Required: False ,
}
{
value:
{
Description: Resource name. ,
Required: False ,
}
string ,
localizedValue:
{
Description: Resource display name. ,
Required: False ,
}
string ,
}
,
limit:
{
Description: Quota/limits for the resource. ,
Format: int64 ,
Required: False ,
}
integer ,
usages:
{
Description: Usages for the resource. ,
Format: int64 ,
Required: False ,
}
integer ,
unit:
{
Description: Representing the units of the usage quota. Possible values are: Count, Bytes, Seconds, Percent, CountPerSecond, BytesPerSecond. Based on - https://armwiki.azurewebsites.net/api_contracts/UsagesAPIContract.html?q=usages . Different RPs may have different units, Count, type as int64 should work for most of the integer values. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GroupQuotaLocationSettings_CreateOrUpdate (new)
Description :  Enables the GroupQuotas enforcement for the resource provider and the location specified. The resource provider will start using the group quotas as the overall quota for the subscriptions included in the GroupQuota. The subscriptions cannot request quota at subscription level. The subscriptions share the GroupQuotaLimits assigned to the GroupQuota. If the GroupQuotaLimits is used, then submit a groupQuotaLimit request for the specific resource - provider/location/resource. Once the GroupQuota Enforcement is enabled then, it cannot be deleted or reverted back. To disable GroupQuota Enforcement - 1. Remove all the subscriptions from the groupQuota using the delete API for Subscriptions (Check the example - GroupQuotaSubscriptions_Delete). 2. Ten delete the GroupQuota (Check the example - GroupQuotas_Delete).
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/resourceProviders/{resourceProviderName}/locationSettings/{location}
{
managementGroupId:
{
Description: Management Group Id. ,
Required: True ,
}
string ,
groupQuotaName:
{
Description: The GroupQuota name. The name should be unique for the provided context tenantId/MgId. ,
Required: True ,
}
string ,
resourceProviderName:
{
Description: The resource provider name, such as - Microsoft.Compute. Currently only Microsoft.Compute resource provider supports this API. ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
LocationSettings:
{
Description: The GroupQuota body details for creation or update of a GroupQuota entity. ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
enforcementEnabled:
{
Description: Is the GroupQuota Enforcement enabled for the Azure region. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
NotAvailable: No description available. ,
}
,
Required: False ,
}
enum ,
enforcedGroupName:
{
Description: The EnforcedGroupQuota name, which is enforced for the Azure region. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Request status. ,
Enum:
{
Accepted: No description available. ,
Created: No description available. ,
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
InProgress: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
faultCode:
{
Description: Details of the failure. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
enforcementEnabled:
{
Description: Is the GroupQuota Enforcement enabled for the Azure region. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
NotAvailable: No description available. ,
}
,
Required: False ,
}
enum ,
enforcedGroupName:
{
Description: The EnforcedGroupQuota name, which is enforced for the Azure region. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Request status. ,
Enum:
{
Accepted: No description available. ,
Created: No description available. ,
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
InProgress: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
faultCode:
{
Description: Details of the failure. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation. ,
}
integer ,
location:
{
Description: URL for determining when an operation has completed. Send a GET request to the URL in Location header. The URI should return a 202 until the operation reaches a terminal state and 200 once it reaches a terminal state. For more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#202-accepted-and-location-headers. New guidelines - https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#131-resource-based-long-running-operations-relo ,
}
string ,
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. To get the status of the asynchronous operation, send a GET request to the URL in Azure-AsyncOperation header value. For more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#asynchronous-operations ,
}
string ,
}
,
$schema:
{
Description: The provisioning state for the operation. ,
}
{
properties:
{
Required: False ,
}
{
provisioningState:
{
Description: Request status. ,
Enum:
{
Accepted: No description available. ,
Created: No description available. ,
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
InProgress: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GroupQuotaLocationSettings_Update (new)
Description :  Enables the GroupQuotas enforcement for the resource provider and the location specified. The resource provider will start using the group quotas as the overall quota for the subscriptions included in the GroupQuota. The subscriptions cannot request quota at subscription level. The subscriptions share the GroupQuotaLimits assigned to the GroupQuota. If the GroupQuotaLimits is used, then submit a groupQuotaLimit request for the specific resource - provider/location/resource. Once the GroupQuota Enforcement is enabled then, it cannot be deleted or reverted back. To disable GroupQuota Enforcement - 1. Remove all the subscriptions from the groupQuota using the delete API for Subscriptions (Check the example - GroupQuotaSubscriptions_Delete). 2. Ten delete the GroupQuota (Check the example - GroupQuotas_Delete).
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/resourceProviders/{resourceProviderName}/locationSettings/{location}
{
managementGroupId:
{
Description: Management Group Id. ,
Required: True ,
}
string ,
groupQuotaName:
{
Description: The GroupQuota name. The name should be unique for the provided context tenantId/MgId. ,
Required: True ,
}
string ,
resourceProviderName:
{
Description: The resource provider name, such as - Microsoft.Compute. Currently only Microsoft.Compute resource provider supports this API. ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
LocationSettings:
{
Description: The GroupQuota body details for creation or update of a GroupQuota entity. ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
enforcementEnabled:
{
Description: Is the GroupQuota Enforcement enabled for the Azure region. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
NotAvailable: No description available. ,
}
,
Required: False ,
}
enum ,
enforcedGroupName:
{
Description: The EnforcedGroupQuota name, which is enforced for the Azure region. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Request status. ,
Enum:
{
Accepted: No description available. ,
Created: No description available. ,
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
InProgress: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
faultCode:
{
Description: Details of the failure. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
enforcementEnabled:
{
Description: Is the GroupQuota Enforcement enabled for the Azure region. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
NotAvailable: No description available. ,
}
,
Required: False ,
}
enum ,
enforcedGroupName:
{
Description: The EnforcedGroupQuota name, which is enforced for the Azure region. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Request status. ,
Enum:
{
Accepted: No description available. ,
Created: No description available. ,
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
InProgress: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
faultCode:
{
Description: Details of the failure. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
retry-after:
{
Description: The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation. ,
}
integer ,
location:
{
Description: URL for determining when an operation has completed. Send a GET request to the URL in Location header. The URI should return a 202 until the operation reaches a terminal state and 200 once it reaches a terminal state. For more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#202-accepted-and-location-headers ,
}
string ,
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. To get the status of the asynchronous operation, send a GET request to the URL in Azure-AsyncOperation header value. For more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#asynchronous-operations ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GroupQuotaLocationSettings_Get (new)
Description :  Gets the GroupQuotas enforcement settings for the ResourceProvider/location. The locations, where GroupQuota enforcement is not enabled will return Not Found.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/resourceProviders/{resourceProviderName}/locationSettings/{location}
{
managementGroupId:
{
Description: Management Group Id. ,
Required: True ,
}
string ,
groupQuotaName:
{
Description: The GroupQuota name. The name should be unique for the provided context tenantId/MgId. ,
Required: True ,
}
string ,
resourceProviderName:
{
Description: The resource provider name, such as - Microsoft.Compute. Currently only Microsoft.Compute resource provider supports this API. ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
enforcementEnabled:
{
Description: Is the GroupQuota Enforcement enabled for the Azure region. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
NotAvailable: No description available. ,
}
,
Required: False ,
}
enum ,
enforcedGroupName:
{
Description: The EnforcedGroupQuota name, which is enforced for the Azure region. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Request status. ,
Enum:
{
Accepted: No description available. ,
Created: No description available. ,
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
InProgress: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
faultCode:
{
Description: Details of the failure. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GroupQuotaLocationSettings_List (new)
Description :  Returns only the list of the Azure regions settings, where the GroupQuotas enforcement is enabled. The locations not included in GroupQuota Enforcement will not be listed, the regions in failed status with listed as status Failed.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/resourceProviders/{resourceProviderName}/locationSettings
{
managementGroupId:
{
Description: Management Group Id. ,
Required: True ,
}
string ,
groupQuotaName:
{
Description: The GroupQuota name. The name should be unique for the provided context tenantId/MgId. ,
Required: True ,
}
string ,
resourceProviderName:
{
Description: The resource provider name, such as - Microsoft.Compute. Currently only Microsoft.Compute resource provider supports this API. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Azure Regions. ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
enforcementEnabled:
{
Description: Is the GroupQuota Enforcement enabled for the Azure region. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
NotAvailable: No description available. ,
}
,
Required: False ,
}
enum ,
enforcedGroupName:
{
Description: The EnforcedGroupQuota name, which is enforced for the Azure region. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Request status. ,
Enum:
{
Accepted: No description available. ,
Created: No description available. ,
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
InProgress: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
faultCode:
{
Description: Details of the failure. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}