Share via


ApiResource.GetApiSchemaAsync(String, CancellationToken) Method

Definition

Get the schema configuration at the API level.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/schemas/{schemaId}
  • Operation Id: ApiSchema_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiSchemaResource
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ApiManagement.ApiSchemaResource>> GetApiSchemaAsync (string schemaId, System.Threading.CancellationToken cancellationToken = default);
abstract member GetApiSchemaAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ApiManagement.ApiSchemaResource>>
override this.GetApiSchemaAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ApiManagement.ApiSchemaResource>>
Public Overridable Function GetApiSchemaAsync (schemaId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ApiSchemaResource))

Parameters

schemaId
String

Schema id identifier. Must be unique in the current API Management service instance.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

schemaId is null.

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

Applies to