ApiManagementServiceResource.GetDocumentationContract Method

Definition

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 Azure.Response<Azure.ResourceManager.ApiManagement.DocumentationContractResource> GetDocumentationContract (string documentationId, System.Threading.CancellationToken cancellationToken = default);
abstract member GetDocumentationContract : string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.ApiManagement.DocumentationContractResource>
override this.GetDocumentationContract : string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.ApiManagement.DocumentationContractResource>
Public Overridable Function GetDocumentationContract (documentationId As String, Optional cancellationToken As CancellationToken = Nothing) As 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

Exceptions

documentationId is null.

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

Applies to