ApiPolicyCollection Class

Definition

Namespace:

Azure.ResourceManager.ApiManagement

Assembly:

Azure.ResourceManager.ApiManagement.dll

Package:

Azure.ResourceManager.ApiManagement v1.1.0

Source:

ApiPolicyCollection.cs

A class representing a collection of ApiPolicyResource and their operations. Each ApiPolicyResource in the collection will belong to the same instance of ApiResource. To get an ApiPolicyCollection instance call the GetApiPolicies method from an instance of ApiResource.

public class ApiPolicyCollection : Azure.ResourceManager.ArmCollection, System.Collections.Generic.IAsyncEnumerable<Azure.ResourceManager.ApiManagement.ApiPolicyResource>, System.Collections.Generic.IEnumerable<Azure.ResourceManager.ApiManagement.ApiPolicyResource>

type ApiPolicyCollection = class
    inherit ArmCollection
    interface seq<ApiPolicyResource>
    interface IEnumerable
    interface IAsyncEnumerable<ApiPolicyResource>

Public Class ApiPolicyCollection
Inherits ArmCollection
Implements IAsyncEnumerable(Of ApiPolicyResource), IEnumerable(Of ApiPolicyResource)

Inheritance

Object

ArmCollection

ApiPolicyCollection

Implements

IAsyncEnumerable<ApiPolicyResource> IEnumerable<ApiPolicyResource> IEnumerable

Constructors

ApiPolicyCollection()

Initializes a new instance of the ApiPolicyCollection 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

CreateOrUpdate(WaitUntil, PolicyName, PolicyContractData, Nullable<ETag>, CancellationToken)	Creates or updates policy configuration for the API. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/policies/{policyId} Operation Id: ApiPolicy_CreateOrUpdate Default Api Version: 2021-08-01 Resource: ApiPolicyResource
CreateOrUpdateAsync(WaitUntil, PolicyName, PolicyContractData, Nullable<ETag>, CancellationToken)	Creates or updates policy configuration for the API. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/policies/{policyId} Operation Id: ApiPolicy_CreateOrUpdate Default Api Version: 2021-08-01 Resource: ApiPolicyResource
Exists(PolicyName, Nullable<PolicyExportFormat>, CancellationToken)	Checks to see if the resource exists in azure. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/policies/{policyId} Operation Id: ApiPolicy_Get Default Api Version: 2021-08-01 Resource: ApiPolicyResource
ExistsAsync(PolicyName, Nullable<PolicyExportFormat>, CancellationToken)	Checks to see if the resource exists in azure. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/policies/{policyId} Operation Id: ApiPolicy_Get Default Api Version: 2021-08-01 Resource: ApiPolicyResource
Get(PolicyName, Nullable<PolicyExportFormat>, CancellationToken)	Get the policy configuration at the API level. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/policies/{policyId} Operation Id: ApiPolicy_Get Default Api Version: 2021-08-01 Resource: ApiPolicyResource
GetAll(CancellationToken)	Get the policy configuration at the API level. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/policies Operation Id: ApiPolicy_ListByApi Default Api Version: 2021-08-01 Resource: ApiPolicyResource
GetAllAsync(CancellationToken)	Get the policy configuration at the API level. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/policies Operation Id: ApiPolicy_ListByApi Default Api Version: 2021-08-01 Resource: ApiPolicyResource
GetAsync(PolicyName, Nullable<PolicyExportFormat>, CancellationToken)	Get the policy configuration at the API level. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/policies/{policyId} Operation Id: ApiPolicy_Get Default Api Version: 2021-08-01 Resource: ApiPolicyResource
GetIfExists(PolicyName, Nullable<PolicyExportFormat>, CancellationToken)	Tries to get details for this resource from the service. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/policies/{policyId} Operation Id: ApiPolicy_Get Default Api Version: 2021-08-01 Resource: ApiPolicyResource
GetIfExistsAsync(PolicyName, Nullable<PolicyExportFormat>, CancellationToken)	Tries to get details for this resource from the service. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/policies/{policyId} Operation Id: ApiPolicy_Get Default Api Version: 2021-08-01 Resource: ApiPolicyResource
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<ApiPolicyResource>.GetAsyncEnumerator(CancellationToken)	Returns an enumerator that iterates asynchronously through the collection.
IEnumerable.GetEnumerator()	Returns an enumerator that iterates through a collection.
IEnumerable<ApiPolicyResource>.GetEnumerator()	Returns an enumerator that iterates through the collection.