ManagementGroupResource Class

Definition

A Class representing a ManagementGroup along with the instance operations that can be performed on it.

public class ManagementGroupResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.ManagementGroups.ManagementGroupData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.ManagementGroups.ManagementGroupData>
public class ManagementGroupResource : Azure.ResourceManager.ArmResource
type ManagementGroupResource = class
    inherit ArmResource
    interface IJsonModel<ManagementGroupData>
    interface IPersistableModel<ManagementGroupData>
type ManagementGroupResource = class
    inherit ArmResource
Public Class ManagementGroupResource
Inherits ArmResource
Implements IJsonModel(Of ManagementGroupData), IPersistableModel(Of ManagementGroupData)
Public Class ManagementGroupResource
Inherits ArmResource
Inheritance
ManagementGroupResource
Implements

Constructors

ManagementGroupResource()

Initializes a new instance of the ManagementGroupResource class for mocking.

Fields

ResourceType

Gets the resource type for the operations.

Properties

Client

Gets the ArmClient this resource client was created from.

(Inherited from ArmResource)
Data

Gets the data representing this Feature.

Diagnostics

Gets the diagnostic options for this resource client.

(Inherited from ArmResource)
Endpoint

Gets the base uri for this resource client.

(Inherited from ArmResource)
HasData

Gets whether or not the current instance has data.

Id

Gets the resource identifier.

(Inherited from ArmResource)
Pipeline

Gets the pipeline for this resource client.

(Inherited from ArmResource)

Methods

CanUseTagResource(CancellationToken)

Checks to see if the TagResource API is deployed in the current environment.

(Inherited from ArmResource)
CanUseTagResourceAsync(CancellationToken)

Checks to see if the TagResource API is deployed in the current environment.

(Inherited from ArmResource)
CreateResourceIdentifier(String)

Generate the resource identifier of a ManagementGroupResource instance.

Delete(WaitUntil, String, CancellationToken)

Delete management group. If a management group contains child resources, the request will fail.

  • Request Path: /providers/Microsoft.Management/managementGroups/{groupId}
  • Operation Id: ManagementGroups_Delete
  • Default Api Version: 2021-04-01
  • Resource: ManagementGroupResource
DeleteAsync(WaitUntil, String, CancellationToken)

Delete management group. If a management group contains child resources, the request will fail.

  • Request Path: /providers/Microsoft.Management/managementGroups/{groupId}
  • Operation Id: ManagementGroups_Delete
  • Default Api Version: 2021-04-01
  • Resource: ManagementGroupResource
Get(Nullable<ManagementGroupExpandType>, Nullable<Boolean>, String, String, CancellationToken)

Get the details of the management group.

  • Request Path: /providers/Microsoft.Management/managementGroups/{groupId}
  • Operation Id: ManagementGroups_Get
  • Default Api Version: 2021-04-01
  • Resource: ManagementGroupResource
GetAsync(Nullable<ManagementGroupExpandType>, Nullable<Boolean>, String, String, CancellationToken)

Get the details of the management group.

  • Request Path: /providers/Microsoft.Management/managementGroups/{groupId}
  • Operation Id: ManagementGroups_Get
  • Default Api Version: 2021-04-01
  • Resource: ManagementGroupResource
GetAvailableLocations(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
GetAvailableLocationsAsync(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
GetDescendants(String, Nullable<Int32>, CancellationToken)

List all entities that descend from a management group.

  • Request Path: /providers/Microsoft.Management/managementGroups/{groupId}/descendants
  • Operation Id: ManagementGroups_GetDescendants
  • Default Api Version: 2021-04-01
  • Resource: ManagementGroupResource
GetDescendantsAsync(String, Nullable<Int32>, CancellationToken)

List all entities that descend from a management group.

  • Request Path: /providers/Microsoft.Management/managementGroups/{groupId}/descendants
  • Operation Id: ManagementGroups_GetDescendants
  • Default Api Version: 2021-04-01
  • Resource: ManagementGroupResource
GetManagementGroupPolicyDefinition(String, CancellationToken)

This operation retrieves the policy definition in the given management group with the given name.

  • Request Path: /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policyDefinitions/{policyDefinitionName}
  • Operation Id: PolicyDefinitions_GetAtManagementGroup
  • Default Api Version: 2021-06-01
  • Resource: ManagementGroupPolicyDefinitionResource
GetManagementGroupPolicyDefinitionAsync(String, CancellationToken)

This operation retrieves the policy definition in the given management group with the given name.

  • Request Path: /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policyDefinitions/{policyDefinitionName}
  • Operation Id: PolicyDefinitions_GetAtManagementGroup
  • Default Api Version: 2021-06-01
  • Resource: ManagementGroupPolicyDefinitionResource
GetManagementGroupPolicyDefinitions()

Gets a collection of ManagementGroupPolicyDefinitionResources in the ManagementGroupResource.

GetManagementGroupPolicySetDefinition(String, CancellationToken)

This operation retrieves the policy set definition in the given management group with the given name.

  • Request Path: /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}
  • Operation Id: PolicySetDefinitions_GetAtManagementGroup
  • Default Api Version: 2021-06-01
  • Resource: ManagementGroupPolicySetDefinitionResource
GetManagementGroupPolicySetDefinitionAsync(String, CancellationToken)

This operation retrieves the policy set definition in the given management group with the given name.

  • Request Path: /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}
  • Operation Id: PolicySetDefinitions_GetAtManagementGroup
  • Default Api Version: 2021-06-01
  • Resource: ManagementGroupPolicySetDefinitionResource
GetManagementGroupPolicySetDefinitions()

Gets a collection of ManagementGroupPolicySetDefinitionResources in the ManagementGroupResource.

GetManagementGroupSubscription(String, String, CancellationToken)

Retrieves details about given subscription which is associated with the management group.

  • Request Path: /providers/Microsoft.Management/managementGroups/{groupId}/subscriptions/{subscriptionId}
  • Operation Id: ManagementGroupSubscriptions_GetSubscription
  • Default Api Version: 2021-04-01
  • Resource: ManagementGroupSubscriptionResource
GetManagementGroupSubscriptionAsync(String, String, CancellationToken)

Retrieves details about given subscription which is associated with the management group.

  • Request Path: /providers/Microsoft.Management/managementGroups/{groupId}/subscriptions/{subscriptionId}
  • Operation Id: ManagementGroupSubscriptions_GetSubscription
  • Default Api Version: 2021-04-01
  • Resource: ManagementGroupSubscriptionResource
GetManagementGroupSubscriptions()

Gets a collection of ManagementGroupSubscriptionResources in the ManagementGroup.

GetManagementLock(String, CancellationToken)

Get a management lock by scope.

  • Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName}
  • Operation Id: ManagementLocks_GetByScope
  • Default Api Version: 2020-05-01
  • Resource: ManagementLockResource
(Inherited from ArmResource)
GetManagementLockAsync(String, CancellationToken)

Get a management lock by scope.

  • Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName}
  • Operation Id: ManagementLocks_GetByScope
  • Default Api Version: 2020-05-01
  • Resource: ManagementLockResource
(Inherited from ArmResource)
GetManagementLocks()

Gets a collection of ManagementLockResources in the ArmResource.

(Inherited from ArmResource)
GetPolicyAssignment(String, CancellationToken)

This operation retrieves a single policy assignment, given its name and the scope it was created at.

  • Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
  • Operation Id: PolicyAssignments_Get
  • Default Api Version: 2022-06-01
  • Resource: PolicyAssignmentResource
(Inherited from ArmResource)
GetPolicyAssignmentAsync(String, CancellationToken)

This operation retrieves a single policy assignment, given its name and the scope it was created at.

  • Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
  • Operation Id: PolicyAssignments_Get
  • Default Api Version: 2022-06-01
  • Resource: PolicyAssignmentResource
(Inherited from ArmResource)
GetPolicyAssignments()

Gets a collection of PolicyAssignmentResources in the ArmResource.

(Inherited from ArmResource)
GetTagResource()

Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource.

(Inherited from ArmResource)
TryGetApiVersion(ResourceType, String)

Gets the api version override if it has been set for the current client options.

(Inherited from ArmResource)
Update(ManagementGroupPatch, String, CancellationToken)

Update a management group.

  • Request Path: /providers/Microsoft.Management/managementGroups/{groupId}
  • Operation Id: ManagementGroups_Update
  • Default Api Version: 2021-04-01
  • Resource: ManagementGroupResource
UpdateAsync(ManagementGroupPatch, String, CancellationToken)

Update a management group.

  • Request Path: /providers/Microsoft.Management/managementGroups/{groupId}
  • Operation Id: ManagementGroups_Update
  • Default Api Version: 2021-04-01
  • Resource: ManagementGroupResource

Explicit Interface Implementations

IJsonModel<ManagementGroupData>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<ManagementGroupData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<ManagementGroupData>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<ManagementGroupData>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<ManagementGroupData>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Extension Methods

GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken)

Get role definition by name (GUID).

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId}
  • Operation Id: RoleDefinitions_Get
  • Default Api Version: 2022-04-01
  • Resource: AuthorizationRoleDefinitionResource
GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken)

Get role definition by name (GUID).

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId}
  • Operation Id: RoleDefinitions_Get
  • Default Api Version: 2022-04-01
  • Resource: AuthorizationRoleDefinitionResource
GetAuthorizationRoleDefinitions(ArmResource)

Gets a collection of AuthorizationRoleDefinitionResources in the ArmResource. MockingTo mock this method, please mock GetAuthorizationRoleDefinitions() instead.

GetDenyAssignment(ArmResource, String, CancellationToken)

Get the specified deny assignment.

  • Request Path: /{scope}/providers/Microsoft.Authorization/denyAssignments/{denyAssignmentId}
  • Operation Id: DenyAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: DenyAssignmentResource
GetDenyAssignmentAsync(ArmResource, String, CancellationToken)

Get the specified deny assignment.

  • Request Path: /{scope}/providers/Microsoft.Authorization/denyAssignments/{denyAssignmentId}
  • Operation Id: DenyAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: DenyAssignmentResource
GetDenyAssignments(ArmResource)

Gets a collection of DenyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetDenyAssignments() instead.

GetRoleAssignment(ArmResource, String, String, CancellationToken)

Get a role assignment by scope and name.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}
  • Operation Id: RoleAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: RoleAssignmentResource
GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken)

Get a role assignment by scope and name.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}
  • Operation Id: RoleAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: RoleAssignmentResource
GetRoleAssignments(ArmResource)

Gets a collection of RoleAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignments() instead.

GetRoleAssignmentSchedule(ArmResource, String, CancellationToken)

Get the specified role assignment schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentSchedules/{roleAssignmentScheduleName}
  • Operation Id: RoleAssignmentSchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleResource
GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken)

Get the specified role assignment schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentSchedules/{roleAssignmentScheduleName}
  • Operation Id: RoleAssignmentSchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleResource
GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken)

Gets the specified role assignment schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleInstances/{roleAssignmentScheduleInstanceName}
  • Operation Id: RoleAssignmentScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleInstanceResource
GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken)

Gets the specified role assignment schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleInstances/{roleAssignmentScheduleInstanceName}
  • Operation Id: RoleAssignmentScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleInstanceResource
GetRoleAssignmentScheduleInstances(ArmResource)

Gets a collection of RoleAssignmentScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleInstances() instead.

GetRoleAssignmentScheduleRequest(ArmResource, String, CancellationToken)

Get the specified role assignment schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/{roleAssignmentScheduleRequestName}
  • Operation Id: RoleAssignmentScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleRequestResource
GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken)

Get the specified role assignment schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/{roleAssignmentScheduleRequestName}
  • Operation Id: RoleAssignmentScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleRequestResource
GetRoleAssignmentScheduleRequests(ArmResource)

Gets a collection of RoleAssignmentScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleRequests() instead.

GetRoleAssignmentSchedules(ArmResource)

Gets a collection of RoleAssignmentScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentSchedules() instead.

GetRoleEligibilitySchedule(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilitySchedules/{roleEligibilityScheduleName}
  • Operation Id: RoleEligibilitySchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleResource
GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilitySchedules/{roleEligibilityScheduleName}
  • Operation Id: RoleEligibilitySchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleResource
GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken)

Gets the specified role eligibility schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleInstances/{roleEligibilityScheduleInstanceName}
  • Operation Id: RoleEligibilityScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleInstanceResource
GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken)

Gets the specified role eligibility schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleInstances/{roleEligibilityScheduleInstanceName}
  • Operation Id: RoleEligibilityScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleInstanceResource
GetRoleEligibilityScheduleInstances(ArmResource)

Gets a collection of RoleEligibilityScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleInstances() instead.

GetRoleEligibilityScheduleRequest(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName}
  • Operation Id: RoleEligibilityScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleRequestResource
GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName}
  • Operation Id: RoleEligibilityScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleRequestResource
GetRoleEligibilityScheduleRequests(ArmResource)

Gets a collection of RoleEligibilityScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleRequests() instead.

GetRoleEligibilitySchedules(ArmResource)

Gets a collection of RoleEligibilityScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilitySchedules() instead.

GetRoleManagementPolicies(ArmResource)

Gets a collection of RoleManagementPolicyResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicies() instead.

GetRoleManagementPolicy(ArmResource, String, CancellationToken)

Get the specified role management policy for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicies/{roleManagementPolicyName}
  • Operation Id: RoleManagementPolicies_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyResource
GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken)

Get the specified role management policy assignment for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicyAssignments/{roleManagementPolicyAssignmentName}
  • Operation Id: RoleManagementPolicyAssignments_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyAssignmentResource
GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken)

Get the specified role management policy assignment for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicyAssignments/{roleManagementPolicyAssignmentName}
  • Operation Id: RoleManagementPolicyAssignments_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyAssignmentResource
GetRoleManagementPolicyAssignments(ArmResource)

Gets a collection of RoleManagementPolicyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicyAssignments() instead.

GetRoleManagementPolicyAsync(ArmResource, String, CancellationToken)

Get the specified role management policy for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicies/{roleManagementPolicyName}
  • Operation Id: RoleManagementPolicies_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyResource
GetAggregatedCost(ManagementGroupResource, String, CancellationToken)

Provides the aggregate cost of a management group and all child management groups by current billing period.

  • Request Path: /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Consumption/aggregatedcost
  • Operation Id: AggregatedCost_GetByManagementGroup
GetAggregatedCostAsync(ManagementGroupResource, String, CancellationToken)

Provides the aggregate cost of a management group and all child management groups by current billing period.

  • Request Path: /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Consumption/aggregatedcost
  • Operation Id: AggregatedCost_GetByManagementGroup
GetSystemAssignedIdentity(ArmResource)

Gets an object representing a SystemAssignedIdentityResource along with the instance operations that can be performed on it in the ArmResource. MockingTo mock this method, please mock GetSystemAssignedIdentity() instead.

GetManagementGroupNetworkManagerConnection(ManagementGroupResource, String, CancellationToken)

Get a specified connection created by this management group.

  • Request Path: /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Network/networkManagerConnections/{networkManagerConnectionName}
  • Operation Id: ManagementGroupNetworkManagerConnections_Get
  • Default Api Version: 2024-03-01
  • Resource: ManagementGroupNetworkManagerConnectionResource
GetManagementGroupNetworkManagerConnectionAsync(ManagementGroupResource, String, CancellationToken)

Get a specified connection created by this management group.

  • Request Path: /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Network/networkManagerConnections/{networkManagerConnectionName}
  • Operation Id: ManagementGroupNetworkManagerConnections_Get
  • Default Api Version: 2024-03-01
  • Resource: ManagementGroupNetworkManagerConnectionResource
GetManagementGroupNetworkManagerConnections(ManagementGroupResource)

Gets a collection of ManagementGroupNetworkManagerConnectionResources in the ManagementGroupResource. MockingTo mock this method, please mock GetManagementGroupNetworkManagerConnections() instead.

CheckPolicyRestrictions(ManagementGroupResource, CheckManagementGroupPolicyRestrictionsContent, CancellationToken)

Checks what restrictions Azure Policy will place on resources within a management group.

  • Request Path: /providers/{managementGroupsNamespace}/managementGroups/{managementGroupId}/providers/Microsoft.PolicyInsights/checkPolicyRestrictions
  • Operation Id: PolicyRestrictions_CheckAtManagementGroupScope
CheckPolicyRestrictionsAsync(ManagementGroupResource, CheckManagementGroupPolicyRestrictionsContent, CancellationToken)

Checks what restrictions Azure Policy will place on resources within a management group.

  • Request Path: /providers/{managementGroupsNamespace}/managementGroups/{managementGroupId}/providers/Microsoft.PolicyInsights/checkPolicyRestrictions
  • Operation Id: PolicyRestrictions_CheckAtManagementGroupScope
GetPolicyEventQueryResults(ManagementGroupResource, PolicyEventType, PolicyQuerySettings, CancellationToken)

Queries policy events for the resources under the management group.

  • Request Path: /providers/{managementGroupsNamespace}/managementGroups/{managementGroupName}/providers/Microsoft.PolicyInsights/policyEvents/{policyEventsResource}/queryResults
  • Operation Id: PolicyEvents_ListQueryResultsForManagementGroup
GetPolicyEventQueryResultsAsync(ManagementGroupResource, PolicyEventType, PolicyQuerySettings, CancellationToken)

Queries policy events for the resources under the management group.

  • Request Path: /providers/{managementGroupsNamespace}/managementGroups/{managementGroupName}/providers/Microsoft.PolicyInsights/policyEvents/{policyEventsResource}/queryResults
  • Operation Id: PolicyEvents_ListQueryResultsForManagementGroup
GetPolicyStateQueryResults(ManagementGroupResource, PolicyStateType, PolicyQuerySettings, CancellationToken)

Queries policy states for the resources under the management group.

  • Request Path: /providers/{managementGroupsNamespace}/managementGroups/{managementGroupName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults
  • Operation Id: PolicyStates_ListQueryResultsForManagementGroup
GetPolicyStateQueryResultsAsync(ManagementGroupResource, PolicyStateType, PolicyQuerySettings, CancellationToken)

Queries policy states for the resources under the management group.

  • Request Path: /providers/{managementGroupsNamespace}/managementGroups/{managementGroupName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults
  • Operation Id: PolicyStates_ListQueryResultsForManagementGroup
GetPolicyTrackedResourceQueryResults(ManagementGroupResource, PolicyTrackedResourceType, PolicyQuerySettings, CancellationToken)

Queries policy tracked resources under the management group.

  • Request Path: /providers/{managementGroupsNamespace}/managementGroups/{managementGroupName}/providers/Microsoft.PolicyInsights/policyTrackedResources/{policyTrackedResourcesResource}/queryResults
  • Operation Id: PolicyTrackedResources_ListQueryResultsForManagementGroup
GetPolicyTrackedResourceQueryResultsAsync(ManagementGroupResource, PolicyTrackedResourceType, PolicyQuerySettings, CancellationToken)

Queries policy tracked resources under the management group.

  • Request Path: /providers/{managementGroupsNamespace}/managementGroups/{managementGroupName}/providers/Microsoft.PolicyInsights/policyTrackedResources/{policyTrackedResourcesResource}/queryResults
  • Operation Id: PolicyTrackedResources_ListQueryResultsForManagementGroup
SummarizePolicyStates(ManagementGroupResource, PolicyStateSummaryType, PolicyQuerySettings, CancellationToken)

Summarizes policy states for the resources under the management group.

  • Request Path: /providers/{managementGroupsNamespace}/managementGroups/{managementGroupName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesSummaryResource}/summarize
  • Operation Id: PolicyStates_SummarizeForManagementGroup
SummarizePolicyStatesAsync(ManagementGroupResource, PolicyStateSummaryType, PolicyQuerySettings, CancellationToken)

Summarizes policy states for the resources under the management group.

  • Request Path: /providers/{managementGroupsNamespace}/managementGroups/{managementGroupName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesSummaryResource}/summarize
  • Operation Id: PolicyStates_SummarizeForManagementGroup
CreateOrUpdateGroupQuotaSubscriptionAllocationRequest(ManagementGroupResource, WaitUntil, String, String, String, String, QuotaAllocationRequestStatusData, CancellationToken)

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.

  • Request Path: /providers/Microsoft.Management/managementGroups/{managementGroupId}/subscriptions/{subscriptionId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/resourceProviders/{resourceProviderName}/quotaAllocationRequests/{resourceName}
  • Operation Id: GroupQuotaSubscriptionAllocationRequest_CreateOrUpdate
  • Default Api Version: 2023-06-01-preview
  • Resource: QuotaAllocationRequestStatusResource
CreateOrUpdateGroupQuotaSubscriptionAllocationRequestAsync(ManagementGroupResource, WaitUntil, String, String, String, String, QuotaAllocationRequestStatusData, CancellationToken)

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.

  • Request Path: /providers/Microsoft.Management/managementGroups/{managementGroupId}/subscriptions/{subscriptionId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/resourceProviders/{resourceProviderName}/quotaAllocationRequests/{resourceName}
  • Operation Id: GroupQuotaSubscriptionAllocationRequest_CreateOrUpdate
  • Default Api Version: 2023-06-01-preview
  • Resource: QuotaAllocationRequestStatusResource
GetGroupQuotaEntities(ManagementGroupResource)

Gets a collection of GroupQuotaEntityResources in the ManagementGroupResource. MockingTo mock this method, please mock GetGroupQuotaEntities() instead.

GetGroupQuotaEntity(ManagementGroupResource, String, CancellationToken)

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.

  • Request Path: /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}
  • Operation Id: GroupQuotas_Get
  • Default Api Version: 2023-06-01-preview
  • Resource: GroupQuotaEntityResource
GetGroupQuotaEntityAsync(ManagementGroupResource, String, CancellationToken)

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.

  • Request Path: /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}
  • Operation Id: GroupQuotas_Get
  • Default Api Version: 2023-06-01-preview
  • Resource: GroupQuotaEntityResource
GetQuotaAllocationRequestStatus(ManagementGroupResource, String, String, String, CancellationToken)

Get the quota allocation request status for the subscriptionId by allocationId.

  • Request Path: /providers/Microsoft.Management/managementGroups/{managementGroupId}/subscriptions/{subscriptionId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/quotaAllocationRequests/{allocationId}
  • Operation Id: GroupQuotaSubscriptionAllocationRequest_Get
  • Default Api Version: 2023-06-01-preview
  • Resource: QuotaAllocationRequestStatusResource
GetQuotaAllocationRequestStatusAsync(ManagementGroupResource, String, String, String, CancellationToken)

Get the quota allocation request status for the subscriptionId by allocationId.

  • Request Path: /providers/Microsoft.Management/managementGroups/{managementGroupId}/subscriptions/{subscriptionId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/quotaAllocationRequests/{allocationId}
  • Operation Id: GroupQuotaSubscriptionAllocationRequest_Get
  • Default Api Version: 2023-06-01-preview
  • Resource: QuotaAllocationRequestStatusResource
GetQuotaAllocationRequestStatuses(ManagementGroupResource)

Gets a collection of QuotaAllocationRequestStatusResources in the ManagementGroupResource. MockingTo mock this method, please mock GetQuotaAllocationRequestStatuses() instead.

GetQuotaAllocationRequestStatusesByResourceProvider(ManagementGroupResource, String, String, String, String, CancellationToken)

Get all the quotaAllocationRequests for a resourceProvider/location. The filter paramter for location is required.

  • Request Path: /providers/Microsoft.Management/managementGroups/{managementGroupId}/subscriptions/{subscriptionId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/resourceProviders/{resourceProviderName}/quotaAllocationRequests
  • Operation Id: GroupQuotaSubscriptionAllocationRequest_List
  • Default Api Version: 2023-06-01-preview
  • Resource: QuotaAllocationRequestStatusResource
GetQuotaAllocationRequestStatusesByResourceProviderAsync(ManagementGroupResource, String, String, String, String, CancellationToken)

Get all the quotaAllocationRequests for a resourceProvider/location. The filter paramter for location is required.

  • Request Path: /providers/Microsoft.Management/managementGroups/{managementGroupId}/subscriptions/{subscriptionId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/resourceProviders/{resourceProviderName}/quotaAllocationRequests
  • Operation Id: GroupQuotaSubscriptionAllocationRequest_List
  • Default Api Version: 2023-06-01-preview
  • Resource: QuotaAllocationRequestStatusResource
GetSubscriptionQuotaAllocation(ManagementGroupResource, String, String, String, String, CancellationToken)

Gets Quota allocated to a subscription for the specific Resource Provider, Location, ResourceName. 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.

  • Request Path: /providers/Microsoft.Management/managementGroups/{managementGroupId}/subscriptions/{subscriptionId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/quotaAllocations/{resourceName}
  • Operation Id: GroupQuotaSubscriptionAllocation_Get
  • Default Api Version: 2023-06-01-preview
  • Resource: SubscriptionQuotaAllocationResource
GetSubscriptionQuotaAllocationAsync(ManagementGroupResource, String, String, String, String, CancellationToken)

Gets Quota allocated to a subscription for the specific Resource Provider, Location, ResourceName. 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.

  • Request Path: /providers/Microsoft.Management/managementGroups/{managementGroupId}/subscriptions/{subscriptionId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/quotaAllocations/{resourceName}
  • Operation Id: GroupQuotaSubscriptionAllocation_Get
  • Default Api Version: 2023-06-01-preview
  • Resource: SubscriptionQuotaAllocationResource
GetSubscriptionQuotaAllocations(ManagementGroupResource, String, String)

Gets a collection of SubscriptionQuotaAllocationResources in the ManagementGroupResource. MockingTo mock this method, please mock GetSubscriptionQuotaAllocations(String, String) instead.

UpdateGroupQuotaSubscriptionAllocationRequest(ManagementGroupResource, WaitUntil, String, String, String, String, QuotaAllocationRequestStatusData, CancellationToken)

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.

  • Request Path: /providers/Microsoft.Management/managementGroups/{managementGroupId}/subscriptions/{subscriptionId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/resourceProviders/{resourceProviderName}/quotaAllocationRequests/{resourceName}
  • Operation Id: GroupQuotaSubscriptionAllocationRequest_Update
  • Default Api Version: 2023-06-01-preview
  • Resource: QuotaAllocationRequestStatusResource
UpdateGroupQuotaSubscriptionAllocationRequestAsync(ManagementGroupResource, WaitUntil, String, String, String, String, QuotaAllocationRequestStatusData, CancellationToken)

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.

  • Request Path: /providers/Microsoft.Management/managementGroups/{managementGroupId}/subscriptions/{subscriptionId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/resourceProviders/{resourceProviderName}/quotaAllocationRequests/{resourceName}
  • Operation Id: GroupQuotaSubscriptionAllocationRequest_Update
  • Default Api Version: 2023-06-01-preview
  • Resource: QuotaAllocationRequestStatusResource
GetArmDeployment(ManagementGroupResource, String, CancellationToken)

Gets a deployment.

  • Request Path: /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}
  • Operation Id: Deployments_GetAtScope
  • Default Api Version: 2024-03-01
  • Resource: ArmDeploymentResource
GetArmDeploymentAsync(ManagementGroupResource, String, CancellationToken)

Gets a deployment.

  • Request Path: /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}
  • Operation Id: Deployments_GetAtScope
  • Default Api Version: 2024-03-01
  • Resource: ArmDeploymentResource
GetArmDeployments(ManagementGroupResource)

Gets a collection of ArmDeploymentResources in the ManagementGroupResource. MockingTo mock this method, please mock GetArmDeployments() instead.

GetDeploymentStack(ManagementGroupResource, String, CancellationToken)

Gets a Deployment stack with a given name at specific scope.

  • Request Path: /{scope}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}
  • Operation Id: DeploymentStacks_GetAtScope
  • Default Api Version: 2024-03-01
  • Resource: DeploymentStackResource
GetDeploymentStackAsync(ManagementGroupResource, String, CancellationToken)

Gets a Deployment stack with a given name at specific scope.

  • Request Path: /{scope}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}
  • Operation Id: DeploymentStacks_GetAtScope
  • Default Api Version: 2024-03-01
  • Resource: DeploymentStackResource
GetDeploymentStacks(ManagementGroupResource)

Gets a collection of DeploymentStackResources in the ManagementGroupResource. MockingTo mock this method, please mock GetDeploymentStacks() instead.

GetLinkerResource(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
GetLinkerResourceAsync(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
GetLinkerResources(ArmResource)

Gets a collection of LinkerResources in the ArmResource. MockingTo mock this method, please mock GetLinkerResources() instead.

Applies to