Share via

ManagementGroupResource Class

Definition

Namespace:
Azure.ResourceManager.ManagementGroups
Assembly:
Azure.ResourceManager.dll
Package:
Azure.ResourceManager v1.13.1
Package:
Azure.ResourceManager v1.14.0-beta.1
Source:
ManagementGroupResource.cs
Source:
ManagementGroupResource.cs

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>
type ManagementGroupResource = class
    inherit ArmResource
    interface IJsonModel<ManagementGroupData>
    interface IPersistableModel<ManagementGroupData>
Public Class ManagementGroupResource
Inherits ArmResource
Implements IJsonModel(Of ManagementGroupData), IPersistableModel(Of ManagementGroupData)
Inheritance
Object
ArmResource
ManagementGroupResource
Implements
IJsonModel<ManagementGroupData> IPersistableModel<ManagementGroupData> IPersistableModel<T>

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
<item>MockingTo mock this method, please mock GetAuthorizationRoleDefinition(ResourceIdentifier, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetAuthorizationRoleDefinitionAsync(ResourceIdentifier, CancellationToken) instead.</item>
GetAuthorizationRoleDefinitions(ArmResource)

Gets a collection of AuthorizationRoleDefinitionResources in the ArmResource. <item>MockingTo mock this method, please mock GetAuthorizationRoleDefinitions() instead.</item>
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
<item>MockingTo mock this method, please mock GetDenyAssignment(String, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetDenyAssignmentAsync(String, CancellationToken) instead.</item>
GetDenyAssignments(ArmResource)

Gets a collection of DenyAssignmentResources in the ArmResource. <item>MockingTo mock this method, please mock GetDenyAssignments() instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleAssignment(String, String, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleAssignmentAsync(String, String, CancellationToken) instead.</item>
GetRoleAssignments(ArmResource)

Gets a collection of RoleAssignmentResources in the ArmResource. <item>MockingTo mock this method, please mock GetRoleAssignments() instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleAssignmentSchedule(String, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleAssignmentScheduleAsync(String, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleAssignmentScheduleInstance(String, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleAssignmentScheduleInstanceAsync(String, CancellationToken) instead.</item>
GetRoleAssignmentScheduleInstances(ArmResource)

Gets a collection of RoleAssignmentScheduleInstanceResources in the ArmResource. <item>MockingTo mock this method, please mock GetRoleAssignmentScheduleInstances() instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleAssignmentScheduleRequest(String, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleAssignmentScheduleRequestAsync(String, CancellationToken) instead.</item>
GetRoleAssignmentScheduleRequests(ArmResource)

Gets a collection of RoleAssignmentScheduleRequestResources in the ArmResource. <item>MockingTo mock this method, please mock GetRoleAssignmentScheduleRequests() instead.</item>
GetRoleAssignmentSchedules(ArmResource)

Gets a collection of RoleAssignmentScheduleResources in the ArmResource. <item>MockingTo mock this method, please mock GetRoleAssignmentSchedules() instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleEligibilitySchedule(String, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleEligibilityScheduleAsync(String, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleEligibilityScheduleInstance(String, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleEligibilityScheduleInstanceAsync(String, CancellationToken) instead.</item>
GetRoleEligibilityScheduleInstances(ArmResource)

Gets a collection of RoleEligibilityScheduleInstanceResources in the ArmResource. <item>MockingTo mock this method, please mock GetRoleEligibilityScheduleInstances() instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleEligibilityScheduleRequest(String, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleEligibilityScheduleRequestAsync(String, CancellationToken) instead.</item>
GetRoleEligibilityScheduleRequests(ArmResource)

Gets a collection of RoleEligibilityScheduleRequestResources in the ArmResource. <item>MockingTo mock this method, please mock GetRoleEligibilityScheduleRequests() instead.</item>
GetRoleEligibilitySchedules(ArmResource)

Gets a collection of RoleEligibilityScheduleResources in the ArmResource. <item>MockingTo mock this method, please mock GetRoleEligibilitySchedules() instead.</item>
GetRoleManagementPolicies(ArmResource)

Gets a collection of RoleManagementPolicyResources in the ArmResource. <item>MockingTo mock this method, please mock GetRoleManagementPolicies() instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleManagementPolicy(String, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleManagementPolicyAssignment(String, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleManagementPolicyAssignmentAsync(String, CancellationToken) instead.</item>
GetRoleManagementPolicyAssignments(ArmResource)

Gets a collection of RoleManagementPolicyAssignmentResources in the ArmResource. <item>MockingTo mock this method, please mock GetRoleManagementPolicyAssignments() instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleManagementPolicyAsync(String, CancellationToken) instead.</item>
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
  • Default Api Version: 2021-10-01
<item>MockingTo mock this method, please mock GetAggregatedCost(String, CancellationToken) instead.</item>
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
  • Default Api Version: 2021-10-01
<item>MockingTo mock this method, please mock GetAggregatedCost(String, CancellationToken) instead.</item>
GetSystemAssignedIdentity(ArmResource)

Gets an object representing a SystemAssignedIdentityResource along with the instance operations that can be performed on it in the ArmResource. <item>MockingTo mock this method, please mock GetSystemAssignedIdentity() instead.</item>
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-07-01
  • Resource: ManagementGroupNetworkManagerConnectionResource
<item>MockingTo mock this method, please mock GetManagementGroupNetworkManagerConnection(String, CancellationToken) instead.</item>
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-07-01
  • Resource: ManagementGroupNetworkManagerConnectionResource
<item>MockingTo mock this method, please mock GetManagementGroupNetworkManagerConnectionAsync(String, CancellationToken) instead.</item>
GetManagementGroupNetworkManagerConnections(ManagementGroupResource)

Gets a collection of ManagementGroupNetworkManagerConnectionResources in the ManagementGroupResource. <item>MockingTo mock this method, please mock GetManagementGroupNetworkManagerConnections() instead.</item>
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
  • Default Api Version: 2022-03-01
<item>MockingTo mock this method, please mock CheckPolicyRestrictions(CheckManagementGroupPolicyRestrictionsContent, CancellationToken) instead.</item>
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
  • Default Api Version: 2022-03-01
<item>MockingTo mock this method, please mock CheckPolicyRestrictions(CheckManagementGroupPolicyRestrictionsContent, CancellationToken) instead.</item>
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
  • Default Api Version: 2019-10-01
<item>MockingTo mock this method, please mock GetPolicyEventQueryResults(PolicyEventType, PolicyQuerySettings, CancellationToken) instead.</item>
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
  • Default Api Version: 2019-10-01
<item>MockingTo mock this method, please mock GetPolicyEventQueryResults(PolicyEventType, PolicyQuerySettings, CancellationToken) instead.</item>
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
  • Default Api Version: 2019-10-01
<item>MockingTo mock this method, please mock GetPolicyStateQueryResults(PolicyStateType, PolicyQuerySettings, CancellationToken) instead.</item>
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
  • Default Api Version: 2019-10-01
<item>MockingTo mock this method, please mock GetPolicyStateQueryResults(PolicyStateType, PolicyQuerySettings, CancellationToken) instead.</item>
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
  • Default Api Version: 2018-07-01-preview
<item>MockingTo mock this method, please mock GetPolicyTrackedResourceQueryResults(PolicyTrackedResourceType, PolicyQuerySettings, CancellationToken) instead.</item>
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
  • Default Api Version: 2018-07-01-preview
<item>MockingTo mock this method, please mock GetPolicyTrackedResourceQueryResults(PolicyTrackedResourceType, PolicyQuerySettings, CancellationToken) instead.</item>
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
  • Default Api Version: 2019-10-01
<item>MockingTo mock this method, please mock SummarizePolicyStates(PolicyStateSummaryType, PolicyQuerySettings, CancellationToken) instead.</item>
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
  • Default Api Version: 2019-10-01
<item>MockingTo mock this method, please mock SummarizePolicyStates(PolicyStateSummaryType, PolicyQuerySettings, CancellationToken) instead.</item>
GetGroupQuotaEntities(ManagementGroupResource)

Gets a collection of GroupQuotaEntityResources in the ManagementGroupResource. <item>MockingTo mock this method, please mock GetGroupQuotaEntities() instead.</item>
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: 2025-03-01
  • Resource: GroupQuotaEntityResource
<item>MockingTo mock this method, please mock GetGroupQuotaEntity(String, CancellationToken) instead.</item>
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: 2025-03-01
  • Resource: GroupQuotaEntityResource
<item>MockingTo mock this method, please mock GetGroupQuotaEntityAsync(String, CancellationToken) instead.</item>
GetQuotaAllocationRequestStatus(ManagementGroupResource, String, 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}/resourceProviders/{resourceProviderName}/quotaAllocationRequests/{allocationId}
  • Operation Id: GroupQuotaSubscriptionAllocationRequest_Get
  • Default Api Version: 2025-03-01
  • Resource: QuotaAllocationRequestStatusResource
<item>MockingTo mock this method, please mock GetQuotaAllocationRequestStatus(String, String, String, String, CancellationToken) instead.</item>
GetQuotaAllocationRequestStatusAsync(ManagementGroupResource, String, 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}/resourceProviders/{resourceProviderName}/quotaAllocationRequests/{allocationId}
  • Operation Id: GroupQuotaSubscriptionAllocationRequest_Get
  • Default Api Version: 2025-03-01
  • Resource: QuotaAllocationRequestStatusResource
<item>MockingTo mock this method, please mock GetQuotaAllocationRequestStatusAsync(String, String, String, String, CancellationToken) instead.</item>
GetQuotaAllocationRequestStatuses(ManagementGroupResource, String, String, String)

Gets a collection of QuotaAllocationRequestStatusResources in the ManagementGroupResource. <item>MockingTo mock this method, please mock GetQuotaAllocationRequestStatuses(String, String, String) instead.</item>
GetSubscriptionQuotaAllocationsList(ManagementGroupResource, String, String, String, AzureLocation, CancellationToken)

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.

  • Request Path: /providers/Microsoft.Management/managementGroups/{managementGroupId}/subscriptions/{subscriptionId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/resourceProviders/{resourceProviderName}/quotaAllocations/{location}
  • Operation Id: GroupQuotaSubscriptionAllocation_List
  • Default Api Version: 2025-03-01
  • Resource: SubscriptionQuotaAllocationsListResource
<item>MockingTo mock this method, please mock GetSubscriptionQuotaAllocationsList(String, String, String, AzureLocation, CancellationToken) instead.</item>
GetSubscriptionQuotaAllocationsListAsync(ManagementGroupResource, String, String, String, AzureLocation, CancellationToken)

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.

  • Request Path: /providers/Microsoft.Management/managementGroups/{managementGroupId}/subscriptions/{subscriptionId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/resourceProviders/{resourceProviderName}/quotaAllocations/{location}
  • Operation Id: GroupQuotaSubscriptionAllocation_List
  • Default Api Version: 2025-03-01
  • Resource: SubscriptionQuotaAllocationsListResource
<item>MockingTo mock this method, please mock GetSubscriptionQuotaAllocationsListAsync(String, String, String, AzureLocation, CancellationToken) instead.</item>
GetSubscriptionQuotaAllocationsLists(ManagementGroupResource)

Gets a collection of SubscriptionQuotaAllocationsListResources in the ManagementGroupResource. <item>MockingTo mock this method, please mock GetSubscriptionQuotaAllocationsLists() instead.</item>
GetArmDeployment(ManagementGroupResource, String, CancellationToken)

Gets a deployment.

  • Request Path: /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}
  • Operation Id: Deployments_GetAtScope
  • Default Api Version: 2025-04-01
  • Resource: ArmDeploymentResource
<item>MockingTo mock this method, please mock GetArmDeployment(String, CancellationToken) instead.</item>
GetArmDeploymentAsync(ManagementGroupResource, String, CancellationToken)

Gets a deployment.

  • Request Path: /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}
  • Operation Id: Deployments_GetAtScope
  • Default Api Version: 2025-04-01
  • Resource: ArmDeploymentResource
<item>MockingTo mock this method, please mock GetArmDeploymentAsync(String, CancellationToken) instead.</item>
GetArmDeployments(ManagementGroupResource)

Gets a collection of ArmDeploymentResources in the ManagementGroupResource. <item>MockingTo mock this method, please mock GetArmDeployments() instead.</item>
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
<item>MockingTo mock this method, please mock GetDeploymentStack(String, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetDeploymentStackAsync(String, CancellationToken) instead.</item>
GetDeploymentStacks(ManagementGroupResource)

Gets a collection of DeploymentStackResources in the ManagementGroupResource. <item>MockingTo mock this method, please mock GetDeploymentStacks() instead.</item>
GetLinkerResource(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
  • Default Api Version: 2022-05-01
  • Resource: LinkerResource
<item>MockingTo mock this method, please mock GetLinkerResource(String, CancellationToken) instead.</item>
GetLinkerResourceAsync(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
  • Default Api Version: 2022-05-01
  • Resource: LinkerResource
<item>MockingTo mock this method, please mock GetLinkerResourceAsync(String, CancellationToken) instead.</item>
GetLinkerResources(ArmResource)

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

Applies to