Microsoft.Management (preview:2024-12-18)

2024/12/19 • 20 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: string ,
groupQuotaName: string ,
api-version: string ,
GroupQuotaPutRequestBody: object ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (201)

{
$headers:
{
retry-after: integer ,
location: string ,
azure-asyncoperation: string ,
}
,
$schema:
{
properties:
{
provisioningState: enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
groupQuotaName: string ,
api-version: string ,
GroupQuotasPatchRequestBody:
{
properties: object ,
}
,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (202)

{
retry-after: integer ,
location: string ,
azure-asyncoperation: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
groupQuotaName: string ,
api-version: string ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
groupQuotaName: string ,
api-version: string ,
}

⚐ Response (202)

{
retry-after: integer ,
location: string ,
azure-asyncoperation: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
object ,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
groupQuotaName: string ,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
properties:
{
subscriptionId: string ,
provisioningState: enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after: integer ,
location: string ,
azure-asyncoperation: string ,
}
,
$schema:
{
properties:
{
provisioningState: enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
groupQuotaName: string ,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
properties:
{
subscriptionId: string ,
provisioningState: enum ,
}
,
}

⚐ Response (202)

{
retry-after: integer ,
location: string ,
azure-asyncoperation: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
groupQuotaName: string ,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (202)

{
retry-after: integer ,
location: string ,
azure-asyncoperation: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
groupQuotaName: string ,
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
properties:
{
subscriptionId: string ,
provisioningState: enum ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
groupQuotaName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
subscriptionId: string ,
provisioningState: enum ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
groupQuotaName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
subscriptionId: string ,
requestSubmitTime: string ,
provisioningState: enum ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
groupQuotaName: string ,
requestId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
subscriptionId: string ,
requestSubmitTime: string ,
provisioningState: enum ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
groupQuotaName: string ,
resourceProviderName: string ,
location: string ,
api-version: string ,
groupQuotaRequest:
{
properties:
{
provisioningState: enum ,
value:
[
{
properties: string ,
}
,
]
,
nextLink: string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
value:
[
{
properties: string ,
}
,
]
,
nextLink: string ,
}
,
}

⚐ Response (202)

{
retry-after: integer ,
location: string ,
azure-asyncoperation: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
groupQuotaName: string ,
resourceProviderName: string ,
location: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
value:
[
{
properties: string ,
}
,
]
,
nextLink: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
groupQuotaName: string ,
requestId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
requestedResource:
{
properties:
{
limit: integer ,
name:
{
value: string ,
localizedValue: string ,
}
,
region: string ,
comments: string ,
}
,
}
,
requestSubmitTime: string ,
provisioningState: enum ,
faultCode: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
groupQuotaName: string ,
resourceProviderName: string ,
api-version: string ,
$filter: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
requestedResource:
{
properties:
{
limit: integer ,
name:
{
value: string ,
localizedValue: string ,
}
,
region: string ,
comments: string ,
}
,
}
,
requestSubmitTime: string ,
provisioningState: enum ,
faultCode: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
subscriptionId: string ,
groupQuotaName: string ,
resourceProviderName: string ,
location: string ,
api-version: string ,
allocateQuotaRequest:
{
properties:
{
provisioningState: enum ,
value:
[
{
properties: string ,
}
,
]
,
nextLink: string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
value:
[
{
properties: string ,
}
,
]
,
nextLink: string ,
}
,
}

⚐ Response (202)

{
retry-after: integer ,
location: string ,
azure-asyncoperation: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
subscriptionId: string ,
groupQuotaName: string ,
resourceProviderName: string ,
location: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
value:
[
{
properties: string ,
}
,
]
,
nextLink: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
subscriptionId: string ,
groupQuotaName: string ,
resourceProviderName: string ,
allocationId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
requestedResource:
{
properties:
{
limit: integer ,
name:
{
value: string ,
localizedValue: string ,
}
,
region: string ,
}
,
}
,
requestSubmitTime: string ,
provisioningState: enum ,
faultCode: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
subscriptionId: string ,
groupQuotaName: string ,
resourceProviderName: string ,
api-version: string ,
$filter: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
requestedResource:
{
properties:
{
limit: integer ,
name:
{
value: string ,
localizedValue: string ,
}
,
region: string ,
}
,
}
,
requestSubmitTime: string ,
provisioningState: enum ,
faultCode: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}