Class ManagementGroupPolicySetDefinitionResource

Namespace

Azure.ResourceManager.Resources

Assembly

Azure.ResourceManager.dll

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

public class ManagementGroupPolicySetDefinitionResource : ArmResource, IJsonModel<PolicySetDefinitionData>, IPersistableModel<PolicySetDefinitionData>

Inheritance

object

ArmResource

ManagementGroupPolicySetDefinitionResource

Implements

IJsonModel<PolicySetDefinitionData>

IPersistableModel<PolicySetDefinitionData>

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

ManagementGroupPolicySetDefinitionResource()

Initializes a new instance of the ManagementGroupPolicySetDefinitionResource class for mocking.

protected ManagementGroupPolicySetDefinitionResource()

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 PolicySetDefinitionData Data { get; }

Property Value

PolicySetDefinitionData

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 ManagementGroupPolicySetDefinitionResource instance.

public static ResourceIdentifier CreateResourceIdentifier(string managementGroupId, string policySetDefinitionName)

Parameters

managementGroupId string

The managementGroupId.

policySetDefinitionName string

The policySetDefinitionName.

Returns

ResourceIdentifier

Delete(WaitUntil, CancellationToken)

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

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 set definition in the given management group with the given name.

• Request Path/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}
• Operation IdPolicySetDefinitions_DeleteAtManagementGroup
• Default Api Version2021-06-01
• ResourceManagementGroupPolicySetDefinitionResource

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 set definition in the given management group with the given name.

• Request Path/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}
• Operation IdPolicySetDefinitions_GetAtManagementGroup
• Default Api Version2021-06-01
• ResourceManagementGroupPolicySetDefinitionResource

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

Parameters

cancellationToken CancellationToken

The cancellation token to use.

Returns

Response<ManagementGroupPolicySetDefinitionResource>

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

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

Parameters

cancellationToken CancellationToken

The cancellation token to use.

Returns

Task<Response<ManagementGroupPolicySetDefinitionResource>>

Update(WaitUntil, PolicySetDefinitionData, CancellationToken)

This operation creates or updates a 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 IdPolicySetDefinitions_CreateOrUpdateAtManagementGroup
• Default Api Version2021-06-01
• ResourceManagementGroupPolicySetDefinitionResource

public virtual ArmOperation<ManagementGroupPolicySetDefinitionResource> Update(WaitUntil waitUntil, PolicySetDefinitionData 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 PolicySetDefinitionData

The policy set definition properties.

cancellationToken CancellationToken

The cancellation token to use.

Returns

ArmOperation<ManagementGroupPolicySetDefinitionResource>

Exceptions

ArgumentNullException

data is null.

UpdateAsync(WaitUntil, PolicySetDefinitionData, CancellationToken)

This operation creates or updates a 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 IdPolicySetDefinitions_CreateOrUpdateAtManagementGroup
• Default Api Version2021-06-01
• ResourceManagementGroupPolicySetDefinitionResource

public virtual Task<ArmOperation<ManagementGroupPolicySetDefinitionResource>> UpdateAsync(WaitUntil waitUntil, PolicySetDefinitionData 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 PolicySetDefinitionData

The policy set definition properties.

cancellationToken CancellationToken

The cancellation token to use.

Returns

Task<ArmOperation<ManagementGroupPolicySetDefinitionResource>>

Exceptions

ArgumentNullException

data is null.