ApiManagementServiceResource.GetDocumentationContractAsync Method

  • Reference

Definition

Namespace:
Azure.ResourceManager.ApiManagement
Assembly:
Azure.ResourceManager.ApiManagement.dll
Package:
Azure.ResourceManager.ApiManagement v1.2.0
Package:
Azure.ResourceManager.ApiManagement v1.3.0-beta.1
Source:
ApiManagementServiceResource.cs
Source:
ApiManagementServiceResource.cs

Gets the details of the Documentation specified by its identifier.

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

Parameters

documentationId
String

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

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Task<Response<DocumentationContractResource>>

Exceptions

ArgumentNullException

documentationId is null.

ArgumentException

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

Applies to