ManagementGroupResource Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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
- 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.
|
DeleteAsync(WaitUntil, String, CancellationToken) |
Delete management group. If a management group contains child resources, the request will fail.
|
Get(Nullable<ManagementGroupExpandType>, Nullable<Boolean>, String, String, CancellationToken) |
Get the details of the management group.
|
GetAsync(Nullable<ManagementGroupExpandType>, Nullable<Boolean>, String, String, CancellationToken) |
Get the details of the management group.
|
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.
|
GetDescendantsAsync(String, Nullable<Int32>, CancellationToken) |
List all entities that descend from a management group.
|
GetManagementGroupPolicyDefinition(String, CancellationToken) |
This operation retrieves the policy definition in the given management group with the given name.
|
GetManagementGroupPolicyDefinitionAsync(String, CancellationToken) |
This operation retrieves the policy definition in the given management group with the given name.
|
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.
|
GetManagementGroupPolicySetDefinitionAsync(String, CancellationToken) |
This operation retrieves the policy set definition in the given management group with the given name.
|
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.
|
GetManagementGroupSubscriptionAsync(String, String, CancellationToken) |
Retrieves details about given subscription which is associated with the management group.
|
GetManagementGroupSubscriptions() |
Gets a collection of ManagementGroupSubscriptionResources in the ManagementGroup. |
GetManagementLock(String, CancellationToken) |
Get a management lock by scope.
|
GetManagementLockAsync(String, CancellationToken) |
Get a management lock by scope.
|
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.
|
GetPolicyAssignmentAsync(String, CancellationToken) |
This operation retrieves a single policy assignment, given its name and the scope it was created at.
|
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.
|
UpdateAsync(ManagementGroupPatch, String, CancellationToken) |
Update a management group.
|
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).
|
GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken) |
Get role definition by name (GUID).
|
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.
|
GetDenyAssignmentAsync(ArmResource, String, CancellationToken) |
Get the specified deny assignment.
|
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.
|
GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken) |
Get a role assignment by scope and name.
|
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
|
GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken) |
Get the specified role assignment schedule for a resource scope
|
GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken) |
Gets the specified role assignment schedule instance.
|
GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken) |
Gets the specified role assignment schedule instance.
|
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.
|
GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken) |
Get the specified role assignment schedule request.
|
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
|
GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken) |
Get the specified role eligibility schedule for a resource scope
|
GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken) |
Gets the specified role eligibility schedule instance.
|
GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken) |
Gets the specified role eligibility schedule instance.
|
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.
|
GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken) |
Get the specified role eligibility schedule request.
|
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
|
GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken) |
Get the specified role management policy assignment for a resource scope
|
GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken) |
Get the specified role management policy assignment for a resource scope
|
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
|
GetAggregatedCost(ManagementGroupResource, String, CancellationToken) |
Provides the aggregate cost of a management group and all child management groups by current billing period.
|
GetAggregatedCostAsync(ManagementGroupResource, String, CancellationToken) |
Provides the aggregate cost of a management group and all child management groups by current billing period.
|
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.
|
GetManagementGroupNetworkManagerConnectionAsync(ManagementGroupResource, String, CancellationToken) |
Get a specified connection created by this management group.
|
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.
|
CheckPolicyRestrictionsAsync(ManagementGroupResource, CheckManagementGroupPolicyRestrictionsContent, CancellationToken) |
Checks what restrictions Azure Policy will place on resources within a management group.
|
GetPolicyEventQueryResults(ManagementGroupResource, PolicyEventType, PolicyQuerySettings, CancellationToken) |
Queries policy events for the resources under the management group.
|
GetPolicyEventQueryResultsAsync(ManagementGroupResource, PolicyEventType, PolicyQuerySettings, CancellationToken) |
Queries policy events for the resources under the management group.
|
GetPolicyStateQueryResults(ManagementGroupResource, PolicyStateType, PolicyQuerySettings, CancellationToken) |
Queries policy states for the resources under the management group.
|
GetPolicyStateQueryResultsAsync(ManagementGroupResource, PolicyStateType, PolicyQuerySettings, CancellationToken) |
Queries policy states for the resources under the management group.
|
GetPolicyTrackedResourceQueryResults(ManagementGroupResource, PolicyTrackedResourceType, PolicyQuerySettings, CancellationToken) |
Queries policy tracked resources under the management group.
|
GetPolicyTrackedResourceQueryResultsAsync(ManagementGroupResource, PolicyTrackedResourceType, PolicyQuerySettings, CancellationToken) |
Queries policy tracked resources under the management group.
|
SummarizePolicyStates(ManagementGroupResource, PolicyStateSummaryType, PolicyQuerySettings, CancellationToken) |
Summarizes policy states for the resources under the management group.
|
SummarizePolicyStatesAsync(ManagementGroupResource, PolicyStateSummaryType, PolicyQuerySettings, CancellationToken) |
Summarizes policy states for the resources under the management group.
|
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.
|
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.
|
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.
|
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.
|
GetQuotaAllocationRequestStatus(ManagementGroupResource, String, String, String, CancellationToken) |
Get the quota allocation request status for the subscriptionId by allocationId.
|
GetQuotaAllocationRequestStatusAsync(ManagementGroupResource, String, String, String, CancellationToken) |
Get the quota allocation request status for the subscriptionId by allocationId.
|
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.
|
GetQuotaAllocationRequestStatusesByResourceProviderAsync(ManagementGroupResource, String, String, String, String, CancellationToken) |
Get all the quotaAllocationRequests for a resourceProvider/location. The filter paramter for location is required.
|
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.
|
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.
|
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.
|
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.
|
GetArmDeployment(ManagementGroupResource, String, CancellationToken) |
Gets a deployment.
|
GetArmDeploymentAsync(ManagementGroupResource, String, CancellationToken) |
Gets a deployment.
|
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.
|
GetDeploymentStackAsync(ManagementGroupResource, String, CancellationToken) |
Gets a Deployment stack with a given name at specific scope.
|
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.
|
GetLinkerResourceAsync(ArmResource, String, CancellationToken) |
Returns Linker resource for a given name.
|
GetLinkerResources(ArmResource) |
Gets a collection of LinkerResources in the ArmResource. MockingTo mock this method, please mock GetLinkerResources() instead. |