ApiCollection.GetAll Method

Definition

Lists all APIs of the API Management service instance.

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

Parameters

filter
String

| Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| isCurrent | filter | eq, ne | |</br>.

top
Nullable<Int32>

Number of records to return.

skip
Nullable<Int32>

Number of records to skip.

tags
String

Include tags in the response.

expandApiVersionSet
Nullable<Boolean>

Include full ApiVersionSet resource in response.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

A collection of ApiResource that may take multiple service requests to iterate over.

Applies to