MetadataSchemas interface

Package:

@azure/arm-apicenter

Interface representing a MetadataSchemas.

Methods

createOrUpdate(string, string, string, MetadataSchema, MetadataSchemasCreateOrUpdateOptionalParams)	Creates new or updates existing metadata schema.
delete(string, string, string, MetadataSchemasDeleteOptionalParams)	Deletes specified metadata schema.
get(string, string, string, MetadataSchemasGetOptionalParams)	Returns details of the metadata schema.
head(string, string, string, MetadataSchemasHeadOptionalParams)	Checks if specified metadata schema exists.
list(string, string, MetadataSchemasListOptionalParams)	Returns a collection of metadata schemas.

Method Details

createOrUpdate(string, string, string, MetadataSchema, MetadataSchemasCreateOrUpdateOptionalParams)

Creates new or updates existing metadata schema.

function createOrUpdate(resourceGroupName: string, serviceName: string, metadataSchemaName: string, resource: MetadataSchema, options?: MetadataSchemasCreateOrUpdateOptionalParams): Promise<MetadataSchemasCreateOrUpdateResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of Azure API Center service.

metadataSchemaName

string

The name of the metadata schema.

resource

MetadataSchema

Resource create parameters.

options

MetadataSchemasCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<MetadataSchemasCreateOrUpdateResponse>

delete(string, string, string, MetadataSchemasDeleteOptionalParams)

Deletes specified metadata schema.

function delete(resourceGroupName: string, serviceName: string, metadataSchemaName: string, options?: MetadataSchemasDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of Azure API Center service.

metadataSchemaName

string

The name of the metadata schema.

options

MetadataSchemasDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, MetadataSchemasGetOptionalParams)

Returns details of the metadata schema.

function get(resourceGroupName: string, serviceName: string, metadataSchemaName: string, options?: MetadataSchemasGetOptionalParams): Promise<MetadataSchemasGetResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of Azure API Center service.

metadataSchemaName

string

The name of the metadata schema.

options

MetadataSchemasGetOptionalParams

The options parameters.

Returns

Promise<MetadataSchemasGetResponse>

head(string, string, string, MetadataSchemasHeadOptionalParams)

Checks if specified metadata schema exists.

function head(resourceGroupName: string, serviceName: string, metadataSchemaName: string, options?: MetadataSchemasHeadOptionalParams): Promise<MetadataSchemasHeadResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of Azure API Center service.

metadataSchemaName

string

The name of the metadata schema.

options

MetadataSchemasHeadOptionalParams

The options parameters.

Returns

Promise<MetadataSchemasHeadResponse>

list(string, string, MetadataSchemasListOptionalParams)

Returns a collection of metadata schemas.

function list(resourceGroupName: string, serviceName: string, options?: MetadataSchemasListOptionalParams): PagedAsyncIterableIterator<MetadataSchema, MetadataSchema[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of Azure API Center service.

options

MetadataSchemasListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<MetadataSchema, MetadataSchema[], PageSettings>