Share via


ApiTagDescriptionCollection.CreateOrUpdateAsync Method

Definition

Create/Update tag description in scope of the Api.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tagDescriptions/{tagDescriptionId}
  • Operation Id: ApiTagDescription_CreateOrUpdate
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiTagDescriptionResource
public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.ApiManagement.ApiTagDescriptionResource>> CreateOrUpdateAsync (Azure.WaitUntil waitUntil, string tagDescriptionId, Azure.ResourceManager.ApiManagement.Models.ApiTagDescriptionCreateOrUpdateContent content, Azure.ETag? ifMatch = default, System.Threading.CancellationToken cancellationToken = default);
abstract member CreateOrUpdateAsync : Azure.WaitUntil * string * Azure.ResourceManager.ApiManagement.Models.ApiTagDescriptionCreateOrUpdateContent * Nullable<Azure.ETag> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.ApiManagement.ApiTagDescriptionResource>>
override this.CreateOrUpdateAsync : Azure.WaitUntil * string * Azure.ResourceManager.ApiManagement.Models.ApiTagDescriptionCreateOrUpdateContent * Nullable<Azure.ETag> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.ApiManagement.ApiTagDescriptionResource>>
Public Overridable Function CreateOrUpdateAsync (waitUntil As WaitUntil, tagDescriptionId As String, content As ApiTagDescriptionCreateOrUpdateContent, Optional ifMatch As Nullable(Of ETag) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ArmOperation(Of ApiTagDescriptionResource))

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.

tagDescriptionId
String

Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names.

content
ApiTagDescriptionCreateOrUpdateContent

Create parameters.

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

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

tagDescriptionId or content is null.

Applies to