ApiCollection 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:: ApiCollection.cs

Source:: ApiCollection.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 ApiResource and their operations. Each ApiResource in the collection will belong to the same instance of ApiManagementServiceResource. To get an ApiCollection instance call the GetApis method from an instance of ApiManagementServiceResource.

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

type ApiCollection = class
    inherit ArmCollection
    interface seq<ApiResource>
    interface IEnumerable
    interface IAsyncEnumerable<ApiResource>

Public Class ApiCollection
Inherits ArmCollection
Implements IAsyncEnumerable(Of ApiResource), IEnumerable(Of ApiResource)

Inheritance: Object

ArmCollection
ApiCollection

Implements: IAsyncEnumerable<ApiResource> IEnumerable<ApiResource> IEnumerable

Constructors

ApiCollection()

Initializes a new instance of the ApiCollection 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, ApiCreateOrUpdateContent, Nullable<ETag>, CancellationToken)	Creates new or updates existing specified API of the API Management service instance. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId} Operation Id: Api_CreateOrUpdate Default Api Version: 2023-03-01-preview Resource: ApiResource
CreateOrUpdateAsync(WaitUntil, String, ApiCreateOrUpdateContent, Nullable<ETag>, CancellationToken)	Creates new or updates existing specified API of the API Management service instance. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId} Operation Id: Api_CreateOrUpdate Default Api Version: 2023-03-01-preview Resource: ApiResource
Exists(String, CancellationToken)	Checks to see if the resource exists in azure. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId} Operation Id: Api_Get Default Api Version: 2023-03-01-preview Resource: ApiResource
ExistsAsync(String, CancellationToken)	Checks to see if the resource exists in azure. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId} Operation Id: Api_Get Default Api Version: 2023-03-01-preview Resource: ApiResource
Get(String, CancellationToken)	Gets the details of the API specified by its identifier. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId} Operation Id: Api_Get Default Api Version: 2023-03-01-preview Resource: ApiResource
GetAll(String, Nullable<Int32>, Nullable<Int32>, String, Nullable<Boolean>, CancellationToken)	Lists all APIs of the API Management service instance. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis Operation Id: Api_ListByService Default Api Version: 2023-03-01-preview Resource: ApiResource
GetAllAsync(String, Nullable<Int32>, Nullable<Int32>, String, Nullable<Boolean>, CancellationToken)	Lists all APIs of the API Management service instance. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis Operation Id: Api_ListByService Default Api Version: 2023-03-01-preview Resource: ApiResource
GetAsync(String, CancellationToken)	Gets the details of the API specified by its identifier. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId} Operation Id: Api_Get Default Api Version: 2023-03-01-preview Resource: ApiResource
GetIfExists(String, CancellationToken)	Tries to get details for this resource from the service. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId} Operation Id: Api_Get Default Api Version: 2023-03-01-preview Resource: ApiResource
GetIfExistsAsync(String, CancellationToken)	Tries to get details for this resource from the service. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId} Operation Id: Api_Get Default Api Version: 2023-03-01-preview Resource: ApiResource
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<ApiResource>.GetAsyncEnumerator(CancellationToken)	Returns an enumerator that iterates asynchronously through the collection.
IEnumerable.GetEnumerator()	Returns an enumerator that iterates through a collection.
IEnumerable<ApiResource>.GetEnumerator()	Returns an enumerator that iterates through the collection.

Applies to

Share via