Share via


ApiManagementGatewayCollection.CreateOrUpdateAsync Method

Definition

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
public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.ApiManagement.ApiManagementGatewayResource>> CreateOrUpdateAsync (Azure.WaitUntil waitUntil, string gatewayId, Azure.ResourceManager.ApiManagement.ApiManagementGatewayData data, Azure.ETag? ifMatch = default, System.Threading.CancellationToken cancellationToken = default);
abstract member CreateOrUpdateAsync : Azure.WaitUntil * string * Azure.ResourceManager.ApiManagement.ApiManagementGatewayData * Nullable<Azure.ETag> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.ApiManagement.ApiManagementGatewayResource>>
override this.CreateOrUpdateAsync : Azure.WaitUntil * string * Azure.ResourceManager.ApiManagement.ApiManagementGatewayData * Nullable<Azure.ETag> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.ApiManagement.ApiManagementGatewayResource>>
Public Overridable Function CreateOrUpdateAsync (waitUntil As WaitUntil, gatewayId As String, data As ApiManagementGatewayData, Optional ifMatch As Nullable(Of ETag) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ArmOperation(Of ApiManagementGatewayResource))

Parameters

waitUntil
WaitUntil

Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.

gatewayId
String

Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'.

ifMatch
Nullable<ETag>

ETag of the Entity. Not required when creating an entity, but required when updating an entity.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

gatewayId is an empty string, and was expected to be non-empty.

gatewayId or data is null.

Applies to