Share via


ApiManagementUserSubscriptionCollection Class

Definition

A class representing a collection of ApiManagementUserSubscriptionResource and their operations. Each ApiManagementUserSubscriptionResource in the collection will belong to the same instance of ApiManagementUserResource. To get an ApiManagementUserSubscriptionCollection instance call the GetApiManagementUserSubscriptions method from an instance of ApiManagementUserResource.

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

Constructors

ApiManagementUserSubscriptionCollection()

Initializes a new instance of the ApiManagementUserSubscriptionCollection 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

Exists(String, CancellationToken)

Checks to see if the resource exists in azure.

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

Checks to see if the resource exists in azure.

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

Gets the specified Subscription entity associated with a particular user.

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

Lists the collection of subscriptions of the specified user.

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

Lists the collection of subscriptions of the specified user.

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

Gets the specified Subscription entity associated with a particular user.

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

Tries to get details for this resource from the service.

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

Tries to get details for this resource from the service.

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

Returns an enumerator that iterates asynchronously through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerable<ApiManagementUserSubscriptionResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to