Services interface

Пакет:

@azure/arm-apicenter

Интерфейс, представляющий службы.

Методы

beginExportMetadataSchema(string, string, MetadataSchemaExportRequest, ServicesExportMetadataSchemaOptionalParams)	Экспортирует эффективную схему метаданных.
beginExportMetadataSchemaAndWait(string, string, MetadataSchemaExportRequest, ServicesExportMetadataSchemaOptionalParams)	Экспортирует эффективную схему метаданных.
createOrUpdate(string, string, Service, ServicesCreateOrUpdateOptionalParams)	Создает новый или обновляет существующий API.
delete(string, string, ServicesDeleteOptionalParams)	Удаляет указанную службу.
get(string, string, ServicesGetOptionalParams)	Возвращает сведения о службе.
listByResourceGroup(string, ServicesListByResourceGroupOptionalParams)	Возвращает коллекцию служб в группе ресурсов.
listBySubscription(ServicesListBySubscriptionOptionalParams)	Перечисляет службы в подписке Azure.
update(string, string, ServiceUpdate, ServicesUpdateOptionalParams)	Обновляет существующую службу.

Сведения о методе

beginExportMetadataSchema(string, string, MetadataSchemaExportRequest, ServicesExportMetadataSchemaOptionalParams)

Экспортирует эффективную схему метаданных.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Имя не учитывает регистр.

serviceName

string

Имя службы Центра API Azure.

body

MetadataSchemaExportRequest

Содержимое запроса действия

options

ServicesExportMetadataSchemaOptionalParams

Параметры параметров.

Возвращаемое значение

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

beginExportMetadataSchemaAndWait(string, string, MetadataSchemaExportRequest, ServicesExportMetadataSchemaOptionalParams)

Экспортирует эффективную схему метаданных.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Имя не учитывает регистр.

serviceName

string

Имя службы Центра API Azure.

body

MetadataSchemaExportRequest

Содержимое запроса действия

options

ServicesExportMetadataSchemaOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<MetadataSchemaExportResult>

createOrUpdate(string, string, Service, ServicesCreateOrUpdateOptionalParams)

Создает новый или обновляет существующий API.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Имя не учитывает регистр.

serviceName

string

Имя службы Центра API Azure.

resource

Service

Параметры создания ресурсов.

options

ServicesCreateOrUpdateOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<Service>

delete(string, string, ServicesDeleteOptionalParams)

Удаляет указанную службу.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Имя не учитывает регистр.

serviceName

string

Имя службы Центра API Azure.

options

ServicesDeleteOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<void>

get(string, string, ServicesGetOptionalParams)

Возвращает сведения о службе.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Имя не учитывает регистр.

serviceName

string

Имя службы Центра API Azure.

options

ServicesGetOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<Service>

listByResourceGroup(string, ServicesListByResourceGroupOptionalParams)

Возвращает коллекцию служб в группе ресурсов.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Имя не учитывает регистр.

options

ServicesListByResourceGroupOptionalParams

Параметры параметров.

Возвращаемое значение

PagedAsyncIterableIterator<Service, Service[], PageSettings>

listBySubscription(ServicesListBySubscriptionOptionalParams)

Перечисляет службы в подписке Azure.

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

Параметры

options

ServicesListBySubscriptionOptionalParams

Параметры параметров.

Возвращаемое значение

PagedAsyncIterableIterator<Service, Service[], PageSettings>

update(string, string, ServiceUpdate, ServicesUpdateOptionalParams)

Обновляет существующую службу.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Имя не учитывает регистр.

serviceName

string

Имя службы Центра API Azure.

properties

ServiceUpdate

Свойства ресурса, которые необходимо обновить.

options

ServicesUpdateOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<Service>