Freigeben über


Apis interface

Schnittstelle, die eine API darstellt.

Methoden

createOrUpdate(string, string, string, string, Api, ApisCreateOrUpdateOptionalParams)

Erstellt eine neue API oder aktualisiert die vorhandene API.

delete(string, string, string, string, ApisDeleteOptionalParams)

Löscht die angegebene API.

get(string, string, string, string, ApisGetOptionalParams)

Gibt Details der API zurück.

head(string, string, string, string, ApisHeadOptionalParams)

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

list(string, string, string, ApisListOptionalParams)

Gibt eine Auflistung von APIs zurück.

Details zur Methode

createOrUpdate(string, string, string, string, Api, ApisCreateOrUpdateOptionalParams)

Erstellt eine neue API oder aktualisiert die vorhandene API.

function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, resource: Api, options?: ApisCreateOrUpdateOptionalParams): Promise<ApisCreateOrUpdateResponse>

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.

resource
Api

Ressourcenerstellungsparameter.

options
ApisCreateOrUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

delete(string, string, string, string, ApisDeleteOptionalParams)

Löscht die angegebene API.

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

options
ApisDeleteOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<void>

get(string, string, string, string, ApisGetOptionalParams)

Gibt Details der API zurück.

function get(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, options?: ApisGetOptionalParams): Promise<ApisGetResponse>

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.

options
ApisGetOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<ApisGetResponse>

head(string, string, string, string, ApisHeadOptionalParams)

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

function head(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, options?: ApisHeadOptionalParams): Promise<ApisHeadResponse>

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.

options
ApisHeadOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<ApisHeadResponse>

list(string, string, string, ApisListOptionalParams)

Gibt eine Auflistung von APIs zurück.

function list(resourceGroupName: string, serviceName: string, workspaceName: string, options?: ApisListOptionalParams): PagedAsyncIterableIterator<Api, Api[], 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

options
ApisListOptionalParams

Die Optionsparameter.

Gibt zurück