TenantResource.GetTenantPolicyDefinitionAsync Method

Definition

Namespace:

Azure.ResourceManager.Resources

Assembly:

Azure.ResourceManager.dll

Package:

Azure.ResourceManager v1.13.0

Source:

TenantResource.cs

This operation retrieves the built-in policy definition with the given name.

• Request Path: /providers/Microsoft.Authorization/policyDefinitions/{policyDefinitionName}
• Operation Id: PolicyDefinitions_GetBuiltIn
• Default Api Version: 2021-06-01
• Resource: TenantPolicyDefinitionResource

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Resources.TenantPolicyDefinitionResource>> GetTenantPolicyDefinitionAsync (string policyDefinitionName, System.Threading.CancellationToken cancellationToken = default);

abstract member GetTenantPolicyDefinitionAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Resources.TenantPolicyDefinitionResource>>
override this.GetTenantPolicyDefinitionAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Resources.TenantPolicyDefinitionResource>>

Public Overridable Function GetTenantPolicyDefinitionAsync (policyDefinitionName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of TenantPolicyDefinitionResource))

Parameters

policyDefinitionName

String

The name of the built-in policy definition to get.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<TenantPolicyDefinitionResource>>

Exceptions

ArgumentNullException

policyDefinitionName is null.

ArgumentException

policyDefinitionName is an empty string, and was expected to be non-empty.