ApiResource.GetApiSchemaAsync(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:: ApiResource.cs

Source:: ApiResource.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

Task<Response<ApiSchemaResource>>

Exceptions

ArgumentNullException

schemaId is null.

ArgumentException

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

Applies to

Share via