ApiManagementServiceCollection Class

Definition

Namespace:

Azure.ResourceManager.ApiManagement

Assembly:

Azure.ResourceManager.ApiManagement.dll

Package:

Azure.ResourceManager.ApiManagement v1.2.0

Source:

ApiManagementServiceCollection.cs

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

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

type ApiManagementServiceCollection = class
    inherit ArmCollection
    interface seq<ApiManagementServiceResource>
    interface IEnumerable
    interface IAsyncEnumerable<ApiManagementServiceResource>

Public Class ApiManagementServiceCollection
Inherits ArmCollection
Implements IAsyncEnumerable(Of ApiManagementServiceResource), IEnumerable(Of ApiManagementServiceResource)

Inheritance

Object

ArmCollection

ApiManagementServiceCollection

Implements

IAsyncEnumerable<ApiManagementServiceResource> IEnumerable<ApiManagementServiceResource> IEnumerable

Constructors

ApiManagementServiceCollection()

Initializes a new instance of the ApiManagementServiceCollection 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, ApiManagementServiceData, CancellationToken)	Creates or updates an API Management service. This is long running operation and could take several minutes to complete. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName} Operation Id: ApiManagementService_CreateOrUpdate Default Api Version: 2023-03-01-preview Resource: ApiManagementServiceResource
CreateOrUpdateAsync(WaitUntil, String, ApiManagementServiceData, CancellationToken)	Creates or updates an API Management service. This is long running operation and could take several minutes to complete. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName} Operation Id: ApiManagementService_CreateOrUpdate Default Api Version: 2023-03-01-preview Resource: ApiManagementServiceResource
Exists(String, CancellationToken)	Checks to see if the resource exists in azure. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName} Operation Id: ApiManagementService_Get Default Api Version: 2023-03-01-preview Resource: ApiManagementServiceResource
ExistsAsync(String, CancellationToken)	Checks to see if the resource exists in azure. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName} Operation Id: ApiManagementService_Get Default Api Version: 2023-03-01-preview Resource: ApiManagementServiceResource
Get(String, CancellationToken)	Gets an API Management service resource description. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName} Operation Id: ApiManagementService_Get Default Api Version: 2023-03-01-preview Resource: ApiManagementServiceResource
GetAll(CancellationToken)	List all API Management services within a resource group. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service Operation Id: ApiManagementService_ListByResourceGroup Default Api Version: 2023-03-01-preview Resource: ApiManagementServiceResource
GetAllAsync(CancellationToken)	List all API Management services within a resource group. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service Operation Id: ApiManagementService_ListByResourceGroup Default Api Version: 2023-03-01-preview Resource: ApiManagementServiceResource
GetAsync(String, CancellationToken)	Gets an API Management service resource description. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName} Operation Id: ApiManagementService_Get Default Api Version: 2023-03-01-preview Resource: ApiManagementServiceResource
GetIfExists(String, CancellationToken)	Tries to get details for this resource from the service. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName} Operation Id: ApiManagementService_Get Default Api Version: 2023-03-01-preview Resource: ApiManagementServiceResource
GetIfExistsAsync(String, CancellationToken)	Tries to get details for this resource from the service. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName} Operation Id: ApiManagementService_Get Default Api Version: 2023-03-01-preview Resource: ApiManagementServiceResource
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<ApiManagementServiceResource>.GetAsyncEnumerator(CancellationToken)	Returns an enumerator that iterates asynchronously through the collection.
IEnumerable.GetEnumerator()	Returns an enumerator that iterates through a collection.
IEnumerable<ApiManagementServiceResource>.GetEnumerator()	Returns an enumerator that iterates through the collection.