ApiDefinitions interface

Paket:

@azure/arm-apicenter

Schnittstelle, die eine ApiDefinitions darstellt.

Methoden

beginExportSpecification(string, string, string, string, string, string, ApiDefinitionsExportSpecificationOptionalParams)	Exportiert die API-Spezifikation.
beginExportSpecificationAndWait(string, string, string, string, string, string, ApiDefinitionsExportSpecificationOptionalParams)	Exportiert die API-Spezifikation.
beginImportSpecification(string, string, string, string, string, string, ApiSpecImportRequest, ApiDefinitionsImportSpecificationOptionalParams)	Importiert die API-Spezifikation.
beginImportSpecificationAndWait(string, string, string, string, string, string, ApiSpecImportRequest, ApiDefinitionsImportSpecificationOptionalParams)	Importiert die API-Spezifikation.
createOrUpdate(string, string, string, string, string, string, ApiDefinition, ApiDefinitionsCreateOrUpdateOptionalParams)	Erstellt eine neue oder aktualisiert vorhandene API-Definition.
delete(string, string, string, string, string, string, ApiDefinitionsDeleteOptionalParams)	Löscht die angegebene API-Definition.
get(string, string, string, string, string, string, ApiDefinitionsGetOptionalParams)	Gibt Details der API-Definition zurück.
head(string, string, string, string, string, string, ApiDefinitionsHeadOptionalParams)	Überprüft, ob die angegebene API-Definition vorhanden ist.
list(string, string, string, string, string, ApiDefinitionsListOptionalParams)	Gibt eine Auflistung von API-Definitionen zurück.

Details zur Methode

beginExportSpecification(string, string, string, string, string, string, ApiDefinitionsExportSpecificationOptionalParams)

Exportiert die API-Spezifikation.

function beginExportSpecification(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsExportSpecificationOptionalParams): Promise<SimplePollerLike<OperationState<ApiSpecExportResult>, ApiSpecExportResult>>

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.

workspaceName

string

Den Namen des Arbeitsbereichs

apiName

string

Der Name der API.

versionName

string

Der Name der API-Version.

definitionName

string

Der Name der API-Definition.

options

ApiDefinitionsExportSpecificationOptionalParams

Die Optionsparameter.

Gibt zurück

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

beginExportSpecificationAndWait(string, string, string, string, string, string, ApiDefinitionsExportSpecificationOptionalParams)

Exportiert die API-Spezifikation.

function beginExportSpecificationAndWait(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsExportSpecificationOptionalParams): Promise<ApiSpecExportResult>

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.

workspaceName

string

Den Namen des Arbeitsbereichs

apiName

string

Der Name der API.

versionName

string

Der Name der API-Version.

definitionName

string

Der Name der API-Definition.

options

ApiDefinitionsExportSpecificationOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<ApiSpecExportResult>

beginImportSpecification(string, string, string, string, string, string, ApiSpecImportRequest, ApiDefinitionsImportSpecificationOptionalParams)

Importiert die API-Spezifikation.

function beginImportSpecification(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, body: ApiSpecImportRequest, options?: ApiDefinitionsImportSpecificationOptionalParams): Promise<SimplePollerLike<OperationState<void>, 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.

workspaceName

string

Den Namen des Arbeitsbereichs

apiName

string

Der Name der API.

versionName

string

Der Name der API-Version.

definitionName

string

Der Name der API-Definition.

body

ApiSpecImportRequest

Der Inhalt der Aktionsanforderung

options

ApiDefinitionsImportSpecificationOptionalParams

Die Optionsparameter.

Gibt zurück

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

beginImportSpecificationAndWait(string, string, string, string, string, string, ApiSpecImportRequest, ApiDefinitionsImportSpecificationOptionalParams)

Importiert die API-Spezifikation.

function beginImportSpecificationAndWait(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, body: ApiSpecImportRequest, options?: ApiDefinitionsImportSpecificationOptionalParams): 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.

workspaceName

string

Den Namen des Arbeitsbereichs

apiName

string

Der Name der API.

versionName

string

Der Name der API-Version.

definitionName

string

Der Name der API-Definition.

body

ApiSpecImportRequest

Der Inhalt der Aktionsanforderung

options

ApiDefinitionsImportSpecificationOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<void>

createOrUpdate(string, string, string, string, string, string, ApiDefinition, ApiDefinitionsCreateOrUpdateOptionalParams)

Erstellt eine neue oder aktualisiert vorhandene API-Definition.

function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, resource: ApiDefinition, options?: ApiDefinitionsCreateOrUpdateOptionalParams): Promise<ApiDefinitionsCreateOrUpdateResponse>

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.

workspaceName

string

Den Namen des Arbeitsbereichs

apiName

string

Der Name der API.

versionName

string

Der Name der API-Version.

definitionName

string

Der Name der API-Definition.

resource

ApiDefinition

Ressourcenerstellungsparameter.

options

ApiDefinitionsCreateOrUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<ApiDefinitionsCreateOrUpdateResponse>

delete(string, string, string, string, string, string, ApiDefinitionsDeleteOptionalParams)

Löscht die angegebene API-Definition.

function delete(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsDeleteOptionalParams): 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.

workspaceName

string

Den Namen des Arbeitsbereichs

apiName

string

Der Name der API.

versionName

string

Der Name der API-Version.

definitionName

string

Der Name der API-Definition.

options

ApiDefinitionsDeleteOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<void>

get(string, string, string, string, string, string, ApiDefinitionsGetOptionalParams)

Gibt Details der API-Definition zurück.

function get(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsGetOptionalParams): Promise<ApiDefinitionsGetResponse>

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.

workspaceName

string

Den Namen des Arbeitsbereichs

apiName

string

Der Name der API.

versionName

string

Der Name der API-Version.

definitionName

string

Der Name der API-Definition.

options

ApiDefinitionsGetOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<ApiDefinitionsGetResponse>

head(string, string, string, string, string, string, ApiDefinitionsHeadOptionalParams)

Überprüft, ob die angegebene API-Definition vorhanden ist.

function head(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsHeadOptionalParams): Promise<ApiDefinitionsHeadResponse>

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.

workspaceName

string

Den Namen des Arbeitsbereichs

apiName

string

Der Name der API.

versionName

string

Der Name der API-Version.

definitionName

string

Der Name der API-Definition.

options

ApiDefinitionsHeadOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<ApiDefinitionsHeadResponse>

list(string, string, string, string, string, ApiDefinitionsListOptionalParams)

Gibt eine Auflistung von API-Definitionen zurück.

function list(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, options?: ApiDefinitionsListOptionalParams): PagedAsyncIterableIterator<ApiDefinition, ApiDefinition[], PageSettings>

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.

workspaceName

string

Den Namen des Arbeitsbereichs

apiName

string

Der Name der API.

versionName

string

Der Name der API-Version.

options

ApiDefinitionsListOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<ApiDefinition, ApiDefinition[], PageSettings>