Share via


ApiManagementProductCollection Class

Definition

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

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

Constructors

ApiManagementProductCollection()

Initializes a new instance of the ApiManagementProductCollection 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, String, ApiManagementProductData, Nullable<ETag>, CancellationToken)

Creates or Updates a product.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}
  • Operation Id: Product_CreateOrUpdate
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementProductResource
CreateOrUpdateAsync(WaitUntil, String, ApiManagementProductData, Nullable<ETag>, CancellationToken)

Creates or Updates a product.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}
  • Operation Id: Product_CreateOrUpdate
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementProductResource
Exists(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}
  • Operation Id: Product_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementProductResource
ExistsAsync(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}
  • Operation Id: Product_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementProductResource
Get(String, CancellationToken)

Gets the details of the product specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}
  • Operation Id: Product_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementProductResource
GetAll(String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, String, CancellationToken)

Lists a collection of products in the specified service instance.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products
  • Operation Id: Product_ListByService
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementProductResource
GetAllAsync(String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, String, CancellationToken)

Lists a collection of products in the specified service instance.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products
  • Operation Id: Product_ListByService
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementProductResource
GetAsync(String, CancellationToken)

Gets the details of the product specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}
  • Operation Id: Product_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementProductResource
GetIfExists(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}
  • Operation Id: Product_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementProductResource
GetIfExistsAsync(String, CancellationToken)

Tries to get details for this resource from the service.

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

Returns an enumerator that iterates asynchronously through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerable<ApiManagementProductResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to