IApiSchemaOperations.ListByApiWithHttpMessagesAsync Method

Definition

Get the schema configuration at the API level.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.ApiManagement.Models.SchemaContract>>> ListByApiWithHttpMessagesAsync (string resourceGroupName, string serviceName, string apiId, string filter = default, int? top = default, int? skip = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);
abstract member ListByApiWithHttpMessagesAsync : string * string * string * string * Nullable<int> * Nullable<int> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.ApiManagement.Models.SchemaContract>>>
Public Function ListByApiWithHttpMessagesAsync (resourceGroupName As String, serviceName As String, apiId As String, Optional filter As String = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional skip As Nullable(Of Integer) = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of IPage(Of SchemaContract)))

Parameters

resourceGroupName
String

The name of the resource group.

serviceName
String

The name of the API Management service.

apiId
String

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

filter
String

| Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| contentType | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>

top
Nullable<Int32>

Number of records to return.

skip
Nullable<Int32>

Number of records to skip.

customHeaders
Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken
CancellationToken

The cancellation token.

Returns

Exceptions

Thrown when the operation returned an invalid status code

Thrown when unable to deserialize the response

Thrown when a required parameter is null

Applies to