Share via


ApiManagementSubscriptionCollection Class

Definition

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

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

Constructors

ApiManagementSubscriptionCollection()

Initializes a new instance of the ApiManagementSubscriptionCollection 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, ApiManagementSubscriptionCreateOrUpdateContent, Nullable<Boolean>, Nullable<ETag>, Nullable<AppType>, CancellationToken)

Creates or updates the subscription of specified user to the specified product.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}
  • Operation Id: Subscription_CreateOrUpdate
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementSubscriptionResource
CreateOrUpdateAsync(WaitUntil, String, ApiManagementSubscriptionCreateOrUpdateContent, Nullable<Boolean>, Nullable<ETag>, Nullable<AppType>, CancellationToken)

Creates or updates the subscription of specified user to the specified product.

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

Checks to see if the resource exists in azure.

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

Checks to see if the resource exists in azure.

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

Gets the specified Subscription entity.

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

Lists all subscriptions of the API Management service instance.

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

Lists all subscriptions of the API Management service instance.

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

Gets the specified Subscription entity.

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

Tries to get details for this resource from the service.

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

Tries to get details for this resource from the service.

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

Returns an enumerator that iterates asynchronously through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerable<ApiManagementSubscriptionResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to