Services interface

Paket:

@azure/arm-apicenter

Schnittstelle, die einen Dienst darstellt.

Methoden

beginExportMetadataSchema(string, string, MetadataSchemaExportRequest, ServicesExportMetadataSchemaOptionalParams)	Exportiert das effektive Metadatenschema.
beginExportMetadataSchemaAndWait(string, string, MetadataSchemaExportRequest, ServicesExportMetadataSchemaOptionalParams)	Exportiert das effektive Metadatenschema.
createOrUpdate(string, string, Service, ServicesCreateOrUpdateOptionalParams)	Erstellt eine neue API oder aktualisiert die vorhandene API.
delete(string, string, ServicesDeleteOptionalParams)	Löscht den angegebenen Dienst.
get(string, string, ServicesGetOptionalParams)	Gibt Details des Diensts zurück.
listByResourceGroup(string, ServicesListByResourceGroupOptionalParams)	Gibt eine Sammlung von Diensten innerhalb der Ressourcengruppe zurück.
listBySubscription(ServicesListBySubscriptionOptionalParams)	Listen Dienste in einem Azure-Abonnement.
update(string, string, ServiceUpdate, ServicesUpdateOptionalParams)	Updates vorhandenen Dienst.

Details zur Methode

beginExportMetadataSchema(string, string, MetadataSchemaExportRequest, ServicesExportMetadataSchemaOptionalParams)

Exportiert das effektive Metadatenschema.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des Azure API Center-Diensts.

body

MetadataSchemaExportRequest

Der Inhalt der Aktionsanforderung

options

ServicesExportMetadataSchemaOptionalParams

Die Optionsparameter.

Gibt zurück

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

beginExportMetadataSchemaAndWait(string, string, MetadataSchemaExportRequest, ServicesExportMetadataSchemaOptionalParams)

Exportiert das effektive Metadatenschema.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des Azure API Center-Diensts.

body

MetadataSchemaExportRequest

Der Inhalt der Aktionsanforderung

options

ServicesExportMetadataSchemaOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<MetadataSchemaExportResult>

createOrUpdate(string, string, Service, ServicesCreateOrUpdateOptionalParams)

Erstellt eine neue API oder aktualisiert die vorhandene API.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des Azure API Center-Diensts.

resource

Service

Ressourcenerstellungsparameter.

options

ServicesCreateOrUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<Service>

delete(string, string, ServicesDeleteOptionalParams)

Löscht den angegebenen Dienst.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des Azure API Center-Diensts.

options

ServicesDeleteOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<void>

get(string, string, ServicesGetOptionalParams)

Gibt Details des Diensts zurück.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des Azure API Center-Diensts.

options

ServicesGetOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<Service>

listByResourceGroup(string, ServicesListByResourceGroupOptionalParams)

Gibt eine Sammlung von Diensten innerhalb der Ressourcengruppe zurück.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

options

ServicesListByResourceGroupOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<Service, Service[], PageSettings>

listBySubscription(ServicesListBySubscriptionOptionalParams)

Listen Dienste in einem Azure-Abonnement.

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

Parameter

options

ServicesListBySubscriptionOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<Service, Service[], PageSettings>

update(string, string, ServiceUpdate, ServicesUpdateOptionalParams)

Updates vorhandenen Dienst.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des Azure API Center-Diensts.

properties

ServiceUpdate

Die zu aktualisierenden Ressourceneigenschaften.

options

ServicesUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<Service>