Partilhar via


DocumentationContractResource.UpdateAsync Method

Definition

Updates the details of the Documentation for an API specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/documentations/{documentationId}
  • Operation Id: Documentation_Update
  • Default Api Version: 2023-03-01-preview
  • Resource: DocumentationContractResource
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ApiManagement.DocumentationContractResource>> UpdateAsync (Azure.ETag ifMatch, Azure.ResourceManager.ApiManagement.Models.DocumentationContractPatch patch, System.Threading.CancellationToken cancellationToken = default);
abstract member UpdateAsync : Azure.ETag * Azure.ResourceManager.ApiManagement.Models.DocumentationContractPatch * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ApiManagement.DocumentationContractResource>>
override this.UpdateAsync : Azure.ETag * Azure.ResourceManager.ApiManagement.Models.DocumentationContractPatch * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ApiManagement.DocumentationContractResource>>
Public Overridable Function UpdateAsync (ifMatch As ETag, patch As DocumentationContractPatch, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of DocumentationContractResource))

Parameters

ifMatch
ETag

ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

patch
DocumentationContractPatch

Documentation Update parameters.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

patch is null.

Applies to