TenantPolicyDefinitionCollection Class

  • Reference

Definition

Namespace:
Azure.ResourceManager.Resources
Assembly:
Azure.ResourceManager.dll
Package:
Azure.ResourceManager v1.13.0
Package:
Azure.ResourceManager v1.12.0-beta.1
Source:
TenantPolicyDefinitionCollection.cs
Source:
TenantPolicyDefinitionCollection.cs

A class representing a collection of TenantPolicyDefinitionResource and their operations. Each TenantPolicyDefinitionResource in the collection will belong to the same instance of TenantResource. To get a TenantPolicyDefinitionCollection instance call the GetTenantPolicyDefinitions method from an instance of TenantResource.

public class TenantPolicyDefinitionCollection : Azure.ResourceManager.ArmCollection, System.Collections.Generic.IAsyncEnumerable<Azure.ResourceManager.Resources.TenantPolicyDefinitionResource>, System.Collections.Generic.IEnumerable<Azure.ResourceManager.Resources.TenantPolicyDefinitionResource>
type TenantPolicyDefinitionCollection = class
    inherit ArmCollection
    interface seq<TenantPolicyDefinitionResource>
    interface IEnumerable
    interface IAsyncEnumerable<TenantPolicyDefinitionResource>
Public Class TenantPolicyDefinitionCollection
Inherits ArmCollection
Implements IAsyncEnumerable(Of TenantPolicyDefinitionResource), IEnumerable(Of TenantPolicyDefinitionResource)
Inheritance
Object
ArmCollection
TenantPolicyDefinitionCollection
Implements
IAsyncEnumerable<TenantPolicyDefinitionResource> IEnumerable<TenantPolicyDefinitionResource> IEnumerable

Constructors

TenantPolicyDefinitionCollection()

Initializes a new instance of the TenantPolicyDefinitionCollection class for mocking.

Properties

Client

Gets the ArmClient this resource client was created from.

(Inherited from ArmCollection)
Diagnostics

Gets the diagnostic options for this resource client.

(Inherited from ArmCollection)
Endpoint

Gets the base uri for this resource client.

(Inherited from ArmCollection)
Id

Gets the resource identifier.

(Inherited from ArmCollection)
Pipeline

Gets the pipeline for this resource client.

(Inherited from ArmCollection)

Methods

Exists(String, CancellationToken)

Checks to see if the resource exists in azure.

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

Checks to see if the resource exists in azure.

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

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
GetAll(String, Nullable<Int32>, CancellationToken)

This operation retrieves a list of all the built-in policy definitions that match the optional given $filter. If $filter='policyType -eq {value}' is provided, the returned list only includes all built-in policy definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all built-in policy definitions whose category match the {value}.

  • Request Path: /providers/Microsoft.Authorization/policyDefinitions
  • Operation Id: PolicyDefinitions_ListBuiltIn
  • Default Api Version: 2021-06-01
  • Resource: TenantPolicyDefinitionResource
GetAllAsync(String, Nullable<Int32>, CancellationToken)

This operation retrieves a list of all the built-in policy definitions that match the optional given $filter. If $filter='policyType -eq {value}' is provided, the returned list only includes all built-in policy definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all built-in policy definitions whose category match the {value}.

  • Request Path: /providers/Microsoft.Authorization/policyDefinitions
  • Operation Id: PolicyDefinitions_ListBuiltIn
  • Default Api Version: 2021-06-01
  • Resource: TenantPolicyDefinitionResource
GetAsync(String, CancellationToken)

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
GetIfExists(String, CancellationToken)

Tries to get details for this resource from the service.

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

Tries to get details for this resource from the service.

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

Gets the api version override if it has been set for the current client options.

(Inherited from ArmCollection)

Explicit Interface Implementations

IAsyncEnumerable<TenantPolicyDefinitionResource>.GetAsyncEnumerator(CancellationToken)

Returns an enumerator that iterates asynchronously through the collection.
IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.
IEnumerable<TenantPolicyDefinitionResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to