ApiManagementProductPolicyCollection Class

Definition

A class representing a collection of ApiManagementProductPolicyResource and their operations. Each ApiManagementProductPolicyResource in the collection will belong to the same instance of ApiManagementProductResource. To get an ApiManagementProductPolicyCollection instance call the GetApiManagementProductPolicies method from an instance of ApiManagementProductResource.

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

Constructors

ApiManagementProductPolicyCollection()

Initializes a new instance of the ApiManagementProductPolicyCollection 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 Product.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/policies/{policyId}
  • Operation Id: ProductPolicy_CreateOrUpdate
  • Default Api Version: 2021-08-01
  • Resource: ApiManagementProductPolicyResource
CreateOrUpdateAsync(WaitUntil, PolicyName, PolicyContractData, Nullable<ETag>, CancellationToken)

Creates or updates policy configuration for the Product.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/policies/{policyId}
  • Operation Id: ProductPolicy_CreateOrUpdate
  • Default Api Version: 2021-08-01
  • Resource: ApiManagementProductPolicyResource
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}/products/{productId}/policies/{policyId}
  • Operation Id: ProductPolicy_Get
  • Default Api Version: 2021-08-01
  • Resource: ApiManagementProductPolicyResource
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}/products/{productId}/policies/{policyId}
  • Operation Id: ProductPolicy_Get
  • Default Api Version: 2021-08-01
  • Resource: ApiManagementProductPolicyResource
Get(PolicyName, Nullable<PolicyExportFormat>, CancellationToken)

Get the policy configuration at the Product level.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/policies/{policyId}
  • Operation Id: ProductPolicy_Get
  • Default Api Version: 2021-08-01
  • Resource: ApiManagementProductPolicyResource
GetAll(CancellationToken)

Get the policy configuration at the Product level.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/policies
  • Operation Id: ProductPolicy_ListByProduct
  • Default Api Version: 2021-08-01
  • Resource: ApiManagementProductPolicyResource
GetAllAsync(CancellationToken)

Get the policy configuration at the Product level.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/policies
  • Operation Id: ProductPolicy_ListByProduct
  • Default Api Version: 2021-08-01
  • Resource: ApiManagementProductPolicyResource
GetAsync(PolicyName, Nullable<PolicyExportFormat>, CancellationToken)

Get the policy configuration at the Product level.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/policies/{policyId}
  • Operation Id: ProductPolicy_Get
  • Default Api Version: 2021-08-01
  • Resource: ApiManagementProductPolicyResource
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}/products/{productId}/policies/{policyId}
  • Operation Id: ProductPolicy_Get
  • Default Api Version: 2021-08-01
  • Resource: ApiManagementProductPolicyResource
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}/products/{productId}/policies/{policyId}
  • Operation Id: ProductPolicy_Get
  • Default Api Version: 2021-08-01
  • Resource: ApiManagementProductPolicyResource
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<ApiManagementProductPolicyResource>.GetAsyncEnumerator(CancellationToken)

Returns an enumerator that iterates asynchronously through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerable<ApiManagementProductPolicyResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to