ApiGatewayCollection Class

Definition

Namespace:: Azure.ResourceManager.ApiManagement

Assembly:: Azure.ResourceManager.ApiManagement.dll

Package:: Azure.ResourceManager.ApiManagement v1.3.0

Source:: ApiGatewayCollection.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 ApiGatewayResource and their operations. Each ApiGatewayResource in the collection will belong to the same instance of ResourceGroupResource. To get an ApiGatewayCollection instance call the GetApiGateways method from an instance of ResourceGroupResource.

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

type ApiGatewayCollection = class
    inherit ArmCollection
    interface seq<ApiGatewayResource>
    interface IEnumerable
    interface IAsyncEnumerable<ApiGatewayResource>

Public Class ApiGatewayCollection
Inherits ArmCollection
Implements IAsyncEnumerable(Of ApiGatewayResource), IEnumerable(Of ApiGatewayResource)

Inheritance: Object

ArmCollection
ApiGatewayCollection

Implements: IAsyncEnumerable<ApiGatewayResource> IEnumerable<ApiGatewayResource> IEnumerable

Constructors

ApiGatewayCollection()

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

Applies to