DocumentationContractCollection.GetIfExists(String, CancellationToken) 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:
DocumentationContractCollection.cs
Source:
DocumentationContractCollection.cs

Tries to get details for this resource from the service.

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

NullableResponse<DocumentationContractResource>

Exceptions

ArgumentException

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

ArgumentNullException

documentationId is null.

Applies to