Class ManagementGroupPolicyDefinitionResource

Namespace

Azure.ResourceManager.Resources

Assembly

Azure.ResourceManager.dll

A Class representing a ManagementGroupPolicyDefinition along with the instance operations that can be performed on it. If you have a Azure.Core.ResourceIdentifier you can construct a ManagementGroupPolicyDefinitionResource from an instance of ArmClient using the GetManagementGroupPolicyDefinitionResource method. Otherwise you can get one from its parent resource ManagementGroupResource using the GetManagementGroupPolicyDefinition method.

public class ManagementGroupPolicyDefinitionResource : ArmResource, IJsonModel<PolicyDefinitionData>, IPersistableModel<PolicyDefinitionData>

Inheritance

object

ArmResource

ManagementGroupPolicyDefinitionResource

Implements

IJsonModel<PolicyDefinitionData>

IPersistableModel<PolicyDefinitionData>

Inherited Members

ArmResource.TryGetApiVersion(ResourceType, out string)

ArmResource.GetAvailableLocations(CancellationToken)

ArmResource.GetAvailableLocationsAsync(CancellationToken)

ArmResource.CanUseTagResource(CancellationToken)

ArmResource.CanUseTagResourceAsync(CancellationToken)

ArmResource.GetTagResource()

ArmResource.GetPolicyAssignments()

ArmResource.GetPolicyAssignmentAsync(string, CancellationToken)

ArmResource.GetPolicyAssignment(string, CancellationToken)

ArmResource.GetManagementLocks()

ArmResource.GetManagementLockAsync(string, CancellationToken)

ArmResource.GetManagementLock(string, CancellationToken)

ArmResource.Id

ArmResource.Client

ArmResource.Diagnostics

ArmResource.Pipeline

ArmResource.Endpoint

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ManagementGroupPolicyDefinitionResource()

Initializes a new instance of the ManagementGroupPolicyDefinitionResource class for mocking.

protected ManagementGroupPolicyDefinitionResource()

Fields

ResourceType

Gets the resource type for the operations.

public static readonly ResourceType ResourceType

Field Value

ResourceType

Properties

Data

Gets the data representing this Feature.

public virtual PolicyDefinitionData Data { get; }

Property Value

PolicyDefinitionData

Exceptions

InvalidOperationException

Throws if there is no data loaded in the current instance.

HasData

Gets whether or not the current instance has data.

public virtual bool HasData { get; }

Property Value

bool

Methods

CreateResourceIdentifier(string, string)

Generate the resource identifier of a ManagementGroupPolicyDefinitionResource instance.

public static ResourceIdentifier CreateResourceIdentifier(string managementGroupId, string policyDefinitionName)

Parameters

managementGroupId string

The managementGroupId.

policyDefinitionName string

The policyDefinitionName.

Returns

ResourceIdentifier

Delete(WaitUntil, CancellationToken)

This operation deletes 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 IdPolicyDefinitions_DeleteAtManagementGroup
• Default Api Version2021-06-01
• ResourceManagementGroupPolicyDefinitionResource

public virtual ArmOperation Delete(WaitUntil waitUntil, CancellationToken cancellationToken = default)

Parameters

waitUntil WaitUntil

Azure.WaitUntil.Completed if the method should wait to return until the long-running operation has completed on the service; Azure.WaitUntil.Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.

cancellationToken CancellationToken

The cancellation token to use.

Returns

ArmOperation

DeleteAsync(WaitUntil, CancellationToken)

This operation deletes 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 IdPolicyDefinitions_DeleteAtManagementGroup
• Default Api Version2021-06-01
• ResourceManagementGroupPolicyDefinitionResource

public virtual Task<ArmOperation> DeleteAsync(WaitUntil waitUntil, CancellationToken cancellationToken = default)

Parameters

waitUntil WaitUntil

Azure.WaitUntil.Completed if the method should wait to return until the long-running operation has completed on the service; Azure.WaitUntil.Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.

cancellationToken CancellationToken

The cancellation token to use.

Returns

Task<ArmOperation>

Get(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 IdPolicyDefinitions_GetAtManagementGroup
• Default Api Version2021-06-01
• ResourceManagementGroupPolicyDefinitionResource

public virtual Response<ManagementGroupPolicyDefinitionResource> Get(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

The cancellation token to use.

Returns

Response<ManagementGroupPolicyDefinitionResource>

GetAsync(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 IdPolicyDefinitions_GetAtManagementGroup
• Default Api Version2021-06-01
• ResourceManagementGroupPolicyDefinitionResource

public virtual Task<Response<ManagementGroupPolicyDefinitionResource>> GetAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

The cancellation token to use.

Returns

Task<Response<ManagementGroupPolicyDefinitionResource>>

Update(WaitUntil, PolicyDefinitionData, CancellationToken)

This operation creates or updates a policy definition in the given management group with the given name.

• Request Path/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policyDefinitions/{policyDefinitionName}
• Operation IdPolicyDefinitions_CreateOrUpdateAtManagementGroup
• Default Api Version2021-06-01
• ResourceManagementGroupPolicyDefinitionResource

public virtual ArmOperation<ManagementGroupPolicyDefinitionResource> Update(WaitUntil waitUntil, PolicyDefinitionData data, CancellationToken cancellationToken = default)

Parameters

waitUntil WaitUntil

Azure.WaitUntil.Completed if the method should wait to return until the long-running operation has completed on the service; Azure.WaitUntil.Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.

data PolicyDefinitionData

The policy definition properties.

cancellationToken CancellationToken

The cancellation token to use.

Returns

ArmOperation<ManagementGroupPolicyDefinitionResource>

Exceptions

ArgumentNullException

data is null.

UpdateAsync(WaitUntil, PolicyDefinitionData, CancellationToken)

This operation creates or updates a policy definition in the given management group with the given name.

• Request Path/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policyDefinitions/{policyDefinitionName}
• Operation IdPolicyDefinitions_CreateOrUpdateAtManagementGroup
• Default Api Version2021-06-01
• ResourceManagementGroupPolicyDefinitionResource

public virtual Task<ArmOperation<ManagementGroupPolicyDefinitionResource>> UpdateAsync(WaitUntil waitUntil, PolicyDefinitionData data, CancellationToken cancellationToken = default)

Parameters

waitUntil WaitUntil

Azure.WaitUntil.Completed if the method should wait to return until the long-running operation has completed on the service; Azure.WaitUntil.Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.

data PolicyDefinitionData

The policy definition properties.

cancellationToken CancellationToken

The cancellation token to use.

Returns

Task<ArmOperation<ManagementGroupPolicyDefinitionResource>>

Exceptions

ArgumentNullException

data is null.