Share via


ApiManagementGatewayCollection Class

Definition

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

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

Constructors

ApiManagementGatewayCollection()

Initializes a new instance of the ApiManagementGatewayCollection 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, ApiManagementGatewayData, Nullable<ETag>, CancellationToken)

Creates or updates a Gateway to be used in Api Management instance.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}
  • Operation Id: Gateway_CreateOrUpdate
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementGatewayResource
CreateOrUpdateAsync(WaitUntil, String, ApiManagementGatewayData, Nullable<ETag>, CancellationToken)

Creates or updates a Gateway to be used in Api Management instance.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}
  • Operation Id: Gateway_CreateOrUpdate
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementGatewayResource
Exists(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}
  • Operation Id: Gateway_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementGatewayResource
ExistsAsync(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}
  • Operation Id: Gateway_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementGatewayResource
Get(String, CancellationToken)

Gets the details of the Gateway specified by its identifier.

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

Lists a collection of gateways registered with service instance.

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

Lists a collection of gateways registered with service instance.

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

Gets the details of the Gateway specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}
  • Operation Id: Gateway_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementGatewayResource
GetIfExists(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}
  • Operation Id: Gateway_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementGatewayResource
GetIfExistsAsync(String, CancellationToken)

Tries to get details for this resource from the service.

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

Returns an enumerator that iterates asynchronously through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerable<ApiManagementGatewayResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to