Services interface

Package:

@azure/arm-apicenter

Interface representing a Services.

Methods

beginExportMetadataSchema(string, string, MetadataSchemaExportRequest, ServicesExportMetadataSchemaOptionalParams)	Exports the effective metadata schema.
beginExportMetadataSchemaAndWait(string, string, MetadataSchemaExportRequest, ServicesExportMetadataSchemaOptionalParams)	Exports the effective metadata schema.
createOrUpdate(string, string, Service, ServicesCreateOrUpdateOptionalParams)	Creates new or updates existing API.
delete(string, string, ServicesDeleteOptionalParams)	Deletes specified service.
get(string, string, ServicesGetOptionalParams)	Returns details of the service.
listByResourceGroup(string, ServicesListByResourceGroupOptionalParams)	Returns a collection of services within the resource group.
listBySubscription(ServicesListBySubscriptionOptionalParams)	Lists services within an Azure subscription.
update(string, string, ServiceUpdate, ServicesUpdateOptionalParams)	Updates existing service.

Method Details

beginExportMetadataSchema(string, string, MetadataSchemaExportRequest, ServicesExportMetadataSchemaOptionalParams)

Exports the effective metadata schema.

function beginExportMetadataSchema(resourceGroupName: string, serviceName: string, body: MetadataSchemaExportRequest, options?: ServicesExportMetadataSchemaOptionalParams): Promise<SimplePollerLike<OperationState<MetadataSchemaExportResult>, MetadataSchemaExportResult>>

Parameters

resourceGroupName

string

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

serviceName

string

The name of Azure API Center service.

body

MetadataSchemaExportRequest

The content of the action request

options

ServicesExportMetadataSchemaOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<MetadataSchemaExportResult>, MetadataSchemaExportResult>>

beginExportMetadataSchemaAndWait(string, string, MetadataSchemaExportRequest, ServicesExportMetadataSchemaOptionalParams)

Exports the effective metadata schema.

function beginExportMetadataSchemaAndWait(resourceGroupName: string, serviceName: string, body: MetadataSchemaExportRequest, options?: ServicesExportMetadataSchemaOptionalParams): Promise<MetadataSchemaExportResult>

Parameters

resourceGroupName

string

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

serviceName

string

The name of Azure API Center service.

body

MetadataSchemaExportRequest

The content of the action request

options

ServicesExportMetadataSchemaOptionalParams

The options parameters.

Returns

Promise<MetadataSchemaExportResult>

createOrUpdate(string, string, Service, ServicesCreateOrUpdateOptionalParams)

Creates new or updates existing API.

function createOrUpdate(resourceGroupName: string, serviceName: string, resource: Service, options?: ServicesCreateOrUpdateOptionalParams): Promise<Service>

Parameters

resourceGroupName

string

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

serviceName

string

The name of Azure API Center service.

resource

Service

Resource create parameters.

options

ServicesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Service>

delete(string, string, ServicesDeleteOptionalParams)

Deletes specified service.

function delete(resourceGroupName: string, serviceName: string, options?: ServicesDeleteOptionalParams): 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.

options

ServicesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, ServicesGetOptionalParams)

Returns details of the service.

function get(resourceGroupName: string, serviceName: string, options?: ServicesGetOptionalParams): Promise<Service>

Parameters

resourceGroupName

string

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

serviceName

string

The name of Azure API Center service.

options

ServicesGetOptionalParams

The options parameters.

Returns

Promise<Service>

listByResourceGroup(string, ServicesListByResourceGroupOptionalParams)

Returns a collection of services within the resource group.

function listByResourceGroup(resourceGroupName: string, options?: ServicesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Service, Service[], PageSettings>

Parameters

resourceGroupName

string

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

options

ServicesListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Service, Service[], PageSettings>

listBySubscription(ServicesListBySubscriptionOptionalParams)

Lists services within an Azure subscription.

function listBySubscription(options?: ServicesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Service, Service[], PageSettings>

Parameters

options

ServicesListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Service, Service[], PageSettings>

update(string, string, ServiceUpdate, ServicesUpdateOptionalParams)

Updates existing service.

function update(resourceGroupName: string, serviceName: string, properties: ServiceUpdate, options?: ServicesUpdateOptionalParams): Promise<Service>

Parameters

resourceGroupName

string

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

serviceName

string

The name of Azure API Center service.

properties

ServiceUpdate

The resource properties to be updated.

options

ServicesUpdateOptionalParams

The options parameters.

Returns

Promise<Service>