ApiOperationPolicyCollection Class

Definition

A class representing a collection of ApiOperationPolicyResource and their operations. Each ApiOperationPolicyResource in the collection will belong to the same instance of ApiOperationResource. To get an ApiOperationPolicyCollection instance call the GetApiOperationPolicies method from an instance of ApiOperationResource.

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

Constructors

ApiOperationPolicyCollection()

Initializes a new instance of the ApiOperationPolicyCollection 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 Operation level.

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

Creates or updates policy configuration for the API Operation level.

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

Get the policy configuration at the API Operation level.

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

Get the list of policy configuration at the API Operation level.

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

Get the list of policy configuration at the API Operation level.

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

Get the policy configuration at the API Operation level.

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

Returns an enumerator that iterates asynchronously through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerable<ApiOperationPolicyResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to