Share via

DocumentationContractCollection.GetAllAsync 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

Lists all Documentations of the API Management service instance.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/documentations
  • Operation Id: Documentation_ListByService
  • Default Api Version: 2023-03-01-preview
  • Resource: DocumentationContractResource
public virtual Azure.AsyncPageable<Azure.ResourceManager.ApiManagement.DocumentationContractResource> GetAllAsync (string filter = default, int? top = default, int? skip = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetAllAsync : string * Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.ApiManagement.DocumentationContractResource>
override this.GetAllAsync : string * Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.ApiManagement.DocumentationContractResource>
Public Overridable Function GetAllAsync (Optional filter As String = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional skip As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of DocumentationContractResource)

Parameters

filter
String

| Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | eq | contains |</br>.

top
Nullable<Int32>

Number of records to return.

skip
Nullable<Int32>

Number of records to skip.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

AsyncPageable<DocumentationContractResource>

An async collection of DocumentationContractResource that may take multiple service requests to iterate over.

Applies to