Share via


ApiSchemaCollection Class

Definition

A class representing a collection of ApiSchemaResource and their operations. Each ApiSchemaResource in the collection will belong to the same instance of ApiResource. To get an ApiSchemaCollection instance call the GetApiSchemas method from an instance of ApiResource.

public class ApiSchemaCollection : Azure.ResourceManager.ArmCollection, System.Collections.Generic.IAsyncEnumerable<Azure.ResourceManager.ApiManagement.ApiSchemaResource>, System.Collections.Generic.IEnumerable<Azure.ResourceManager.ApiManagement.ApiSchemaResource>
type ApiSchemaCollection = class
    inherit ArmCollection
    interface seq<ApiSchemaResource>
    interface IEnumerable
    interface IAsyncEnumerable<ApiSchemaResource>
Public Class ApiSchemaCollection
Inherits ArmCollection
Implements IAsyncEnumerable(Of ApiSchemaResource), IEnumerable(Of ApiSchemaResource)
Inheritance
ApiSchemaCollection
Implements

Constructors

ApiSchemaCollection()

Initializes a new instance of the ApiSchemaCollection class for mocking.

Properties

Client

Gets the ArmClient this resource client was created from.

(Inherited from ArmCollection)
Diagnostics

Gets the diagnostic options for this resource client.

(Inherited from ArmCollection)
Endpoint

Gets the base uri for this resource client.

(Inherited from ArmCollection)
Id

Gets the resource identifier.

(Inherited from ArmCollection)
Pipeline

Gets the pipeline for this resource client.

(Inherited from ArmCollection)

Methods

CreateOrUpdate(WaitUntil, String, ApiSchemaData, Nullable<ETag>, CancellationToken)

Creates or updates schema configuration for the API.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/schemas/{schemaId}
  • Operation Id: ApiSchema_CreateOrUpdate
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiSchemaResource
CreateOrUpdateAsync(WaitUntil, String, ApiSchemaData, Nullable<ETag>, CancellationToken)

Creates or updates schema configuration for the API.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/schemas/{schemaId}
  • Operation Id: ApiSchema_CreateOrUpdate
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiSchemaResource
Exists(String, CancellationToken)

Checks to see if the resource exists in azure.

  • 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
ExistsAsync(String, CancellationToken)

Checks to see if the resource exists in azure.

  • 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
Get(String, CancellationToken)

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
GetAll(String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

Get the schema configuration at the API level.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/schemas
  • Operation Id: ApiSchema_ListByApi
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiSchemaResource
GetAllAsync(String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

Get the schema configuration at the API level.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/schemas
  • Operation Id: ApiSchema_ListByApi
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiSchemaResource
GetAsync(String, CancellationToken)

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
GetIfExists(String, CancellationToken)

Tries to get details for this resource from the service.

  • 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
GetIfExistsAsync(String, CancellationToken)

Tries to get details for this resource from the service.

  • 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
TryGetApiVersion(ResourceType, String)

Gets the api version override if it has been set for the current client options.

(Inherited from ArmCollection)

Explicit Interface Implementations

IAsyncEnumerable<ApiSchemaResource>.GetAsyncEnumerator(CancellationToken)

Returns an enumerator that iterates asynchronously through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerable<ApiSchemaResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to