ApiManagementGatewayResource.CreateOrUpdateGatewayApiAsync Method

Definition

Adds an API to the specified Gateway.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/apis/{apiId}
  • Operation Id: GatewayApi_CreateOrUpdate
  • Default Api Version: 2023-03-01-preview
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ApiManagement.Models.GatewayApiData>> CreateOrUpdateGatewayApiAsync (string apiId, Azure.ResourceManager.ApiManagement.Models.AssociationContract associationContract = default, System.Threading.CancellationToken cancellationToken = default);
abstract member CreateOrUpdateGatewayApiAsync : string * Azure.ResourceManager.ApiManagement.Models.AssociationContract * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ApiManagement.Models.GatewayApiData>>
override this.CreateOrUpdateGatewayApiAsync : string * Azure.ResourceManager.ApiManagement.Models.AssociationContract * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ApiManagement.Models.GatewayApiData>>
Public Overridable Function CreateOrUpdateGatewayApiAsync (apiId As String, Optional associationContract As AssociationContract = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of GatewayApiData))

Parameters

apiId
String

API identifier. Must be unique in the current API Management service instance.

associationContract
AssociationContract

The AssociationContract to use.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

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

apiId is null.

Applies to