ApiManagementUserCollection Class

Reference

Definition

Namespace:: Azure.ResourceManager.ApiManagement

Assembly:: Azure.ResourceManager.ApiManagement.dll

Package:: Azure.ResourceManager.ApiManagement v1.2.0

Package:: Azure.ResourceManager.ApiManagement v1.3.0-beta.1

Source:: ApiManagementUserCollection.cs

Source:: ApiManagementUserCollection.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public class ApiManagementUserCollection : Azure.ResourceManager.ArmCollection, System.Collections.Generic.IAsyncEnumerable<Azure.ResourceManager.ApiManagement.ApiManagementUserResource>, System.Collections.Generic.IEnumerable<Azure.ResourceManager.ApiManagement.ApiManagementUserResource>

type ApiManagementUserCollection = class
    inherit ArmCollection
    interface seq<ApiManagementUserResource>
    interface IEnumerable
    interface IAsyncEnumerable<ApiManagementUserResource>

Public Class ApiManagementUserCollection
Inherits ArmCollection
Implements IAsyncEnumerable(Of ApiManagementUserResource), IEnumerable(Of ApiManagementUserResource)

Inheritance: Object

ArmCollection
ApiManagementUserCollection

Implements: IAsyncEnumerable<ApiManagementUserResource> IEnumerable<ApiManagementUserResource> IEnumerable

Constructors

ApiManagementUserCollection()

Initializes a new instance of the ApiManagementUserCollection 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, ApiManagementUserCreateOrUpdateContent, Nullable<Boolean>, Nullable<ETag>, CancellationToken)	Creates or Updates a user. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId} Operation Id: User_CreateOrUpdate Default Api Version: 2023-03-01-preview Resource: ApiManagementUserResource
CreateOrUpdateAsync(WaitUntil, String, ApiManagementUserCreateOrUpdateContent, Nullable<Boolean>, Nullable<ETag>, CancellationToken)	Creates or Updates a user. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId} Operation Id: User_CreateOrUpdate Default Api Version: 2023-03-01-preview Resource: ApiManagementUserResource
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} Operation Id: User_Get Default Api Version: 2023-03-01-preview Resource: ApiManagementUserResource
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} Operation Id: User_Get Default Api Version: 2023-03-01-preview Resource: ApiManagementUserResource
Get(String, CancellationToken)	Gets the details of the user specified by its identifier. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId} Operation Id: User_Get Default Api Version: 2023-03-01-preview Resource: ApiManagementUserResource
GetAll(String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, CancellationToken)	Lists a collection of registered users in the specified service instance. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users Operation Id: User_ListByService Default Api Version: 2023-03-01-preview Resource: ApiManagementUserResource
GetAllAsync(String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, CancellationToken)	Lists a collection of registered users in the specified service instance. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users Operation Id: User_ListByService Default Api Version: 2023-03-01-preview Resource: ApiManagementUserResource
GetAsync(String, CancellationToken)	Gets the details of the user specified by its identifier. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId} Operation Id: User_Get Default Api Version: 2023-03-01-preview Resource: ApiManagementUserResource
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} Operation Id: User_Get Default Api Version: 2023-03-01-preview Resource: ApiManagementUserResource
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} Operation Id: User_Get Default Api Version: 2023-03-01-preview Resource: ApiManagementUserResource
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<ApiManagementUserResource>.GetAsyncEnumerator(CancellationToken)	Returns an enumerator that iterates asynchronously through the collection.
IEnumerable.GetEnumerator()	Returns an enumerator that iterates through a collection.
IEnumerable<ApiManagementUserResource>.GetEnumerator()	Returns an enumerator that iterates through the collection.

Applies to

Share via