Share via


ApiManagementPolicyCollection Class

Definition

A class representing a collection of ApiManagementPolicyResource and their operations. Each ApiManagementPolicyResource in the collection will belong to the same instance of ApiManagementServiceResource. To get an ApiManagementPolicyCollection instance call the GetApiManagementPolicies method from an instance of ApiManagementServiceResource.

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

Constructors

ApiManagementPolicyCollection()

Initializes a new instance of the ApiManagementPolicyCollection 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 the global policy configuration of the Api Management service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policies/{policyId}
  • Operation Id: Policy_CreateOrUpdate
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementPolicyResource
CreateOrUpdateAsync(WaitUntil, PolicyName, PolicyContractData, Nullable<ETag>, CancellationToken)

Creates or updates the global policy configuration of the Api Management service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policies/{policyId}
  • Operation Id: Policy_CreateOrUpdate
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementPolicyResource
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}/policies/{policyId}
  • Operation Id: Policy_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementPolicyResource
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}/policies/{policyId}
  • Operation Id: Policy_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementPolicyResource
Get(PolicyName, Nullable<PolicyExportFormat>, CancellationToken)

Get the Global policy definition of the Api Management service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policies/{policyId}
  • Operation Id: Policy_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementPolicyResource
GetAll(CancellationToken)

Lists all the Global Policy definitions of the Api Management service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policies
  • Operation Id: Policy_ListByService
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementPolicyResource
GetAllAsync(CancellationToken)

Lists all the Global Policy definitions of the Api Management service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policies
  • Operation Id: Policy_ListByService
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementPolicyResource
GetAsync(PolicyName, Nullable<PolicyExportFormat>, CancellationToken)

Get the Global policy definition of the Api Management service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policies/{policyId}
  • Operation Id: Policy_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementPolicyResource
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}/policies/{policyId}
  • Operation Id: Policy_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementPolicyResource
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}/policies/{policyId}
  • Operation Id: Policy_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementPolicyResource
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<ApiManagementPolicyResource>.GetAsyncEnumerator(CancellationToken)

Returns an enumerator that iterates asynchronously through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerable<ApiManagementPolicyResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to