Share via


ApiSchemaCollection.CreateOrUpdate Method

Definition

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
public virtual Azure.ResourceManager.ArmOperation<Azure.ResourceManager.ApiManagement.ApiSchemaResource> CreateOrUpdate (Azure.WaitUntil waitUntil, string schemaId, Azure.ResourceManager.ApiManagement.ApiSchemaData data, Azure.ETag? ifMatch = default, System.Threading.CancellationToken cancellationToken = default);
abstract member CreateOrUpdate : Azure.WaitUntil * string * Azure.ResourceManager.ApiManagement.ApiSchemaData * Nullable<Azure.ETag> * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.ApiManagement.ApiSchemaResource>
override this.CreateOrUpdate : Azure.WaitUntil * string * Azure.ResourceManager.ApiManagement.ApiSchemaData * Nullable<Azure.ETag> * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.ApiManagement.ApiSchemaResource>
Public Overridable Function CreateOrUpdate (waitUntil As WaitUntil, schemaId As String, data As ApiSchemaData, Optional ifMatch As Nullable(Of ETag) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As ArmOperation(Of ApiSchemaResource)

Parameters

waitUntil
WaitUntil

Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.

schemaId
String

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

data
ApiSchemaData

The schema contents to apply.

ifMatch
Nullable<ETag>

ETag of the Entity. Not required when creating an entity, but required when updating an entity.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

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

schemaId or data is null.

Applies to