Workspace interface

Paket:

@azure/arm-apimanagement

Schnittstelle, die einen Arbeitsbereich darstellt.

Methoden

createOrUpdate(string, string, string, WorkspaceContract, WorkspaceCreateOrUpdateOptionalParams)	Erstellt einen neuen Arbeitsbereich oder aktualisiert ein vorhandenes Arbeitsbereich.
delete(string, string, string, string, WorkspaceDeleteOptionalParams)	Löscht den angegebenen Arbeitsbereich.
get(string, string, string, WorkspaceGetOptionalParams)	Ruft die Details des Arbeitsbereichs ab, der durch seinen Bezeichner angegeben wird.
getEntityTag(string, string, string, WorkspaceGetEntityTagOptionalParams)	Ruft die Entitätsstatusversion (Etag) des Arbeitsbereichs ab, der durch seinen Bezeichner angegeben wird.
listByService(string, string, WorkspaceListByServiceOptionalParams)	Listet alle Arbeitsbereiche der API-Verwaltungsdienstinstanz auf.
update(string, string, string, string, WorkspaceContract, WorkspaceUpdateOptionalParams)	Aktualisiert die Details des Arbeitsbereichs, der durch seinen Bezeichner angegeben ist.

Details zur Methode

createOrUpdate(string, string, string, WorkspaceContract, WorkspaceCreateOrUpdateOptionalParams)

Erstellt einen neuen Arbeitsbereich oder aktualisiert ein vorhandenes Arbeitsbereich.

function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, parameters: WorkspaceContract, options?: WorkspaceCreateOrUpdateOptionalParams): Promise<WorkspaceCreateOrUpdateResponse>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API-Verwaltungsdiensts.

workspaceId

string

Arbeitsbereichsbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.

parameters

WorkspaceContract

Erstellen Sie Parameter.

options

WorkspaceCreateOrUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<WorkspaceCreateOrUpdateResponse>

delete(string, string, string, string, WorkspaceDeleteOptionalParams)

Löscht den angegebenen Arbeitsbereich.

function delete(resourceGroupName: string, serviceName: string, workspaceId: string, ifMatch: string, options?: WorkspaceDeleteOptionalParams): Promise<void>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API-Verwaltungsdiensts.

workspaceId

string

Arbeitsbereichsbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.

ifMatch

string

ETag der Entität. ETag sollte mit dem aktuellen Entitätsstatus aus der Headerantwort der GET-Anforderung übereinstimmen, oder es sollte * für bedingungslose Aktualisierung sein.

options

WorkspaceDeleteOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<void>

get(string, string, string, WorkspaceGetOptionalParams)

Ruft die Details des Arbeitsbereichs ab, der durch seinen Bezeichner angegeben wird.

function get(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceGetOptionalParams): Promise<WorkspaceGetResponse>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API-Verwaltungsdiensts.

workspaceId

string

Arbeitsbereichsbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.

options

WorkspaceGetOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<WorkspaceGetResponse>

getEntityTag(string, string, string, WorkspaceGetEntityTagOptionalParams)

Ruft die Entitätsstatusversion (Etag) des Arbeitsbereichs ab, der durch seinen Bezeichner angegeben wird.

function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceGetEntityTagOptionalParams): Promise<WorkspaceGetEntityTagHeaders>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API-Verwaltungsdiensts.

workspaceId

string

Arbeitsbereichsbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.

options

WorkspaceGetEntityTagOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<WorkspaceGetEntityTagHeaders>

listByService(string, string, WorkspaceListByServiceOptionalParams)

Listet alle Arbeitsbereiche der API-Verwaltungsdienstinstanz auf.

function listByService(resourceGroupName: string, serviceName: string, options?: WorkspaceListByServiceOptionalParams): PagedAsyncIterableIterator<WorkspaceContract, WorkspaceContract[], PageSettings>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API-Verwaltungsdiensts.

options

WorkspaceListByServiceOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<WorkspaceContract, WorkspaceContract[], PageSettings>

update(string, string, string, string, WorkspaceContract, WorkspaceUpdateOptionalParams)

Aktualisiert die Details des Arbeitsbereichs, der durch seinen Bezeichner angegeben ist.

function update(resourceGroupName: string, serviceName: string, workspaceId: string, ifMatch: string, parameters: WorkspaceContract, options?: WorkspaceUpdateOptionalParams): Promise<WorkspaceUpdateResponse>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API-Verwaltungsdiensts.

workspaceId

string

Arbeitsbereichsbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.

ifMatch

string

ETag der Entität. ETag sollte mit dem aktuellen Entitätsstatus aus der Headerantwort der GET-Anforderung übereinstimmen, oder es sollte * für bedingungslose Aktualisierung sein.

parameters

WorkspaceContract

Parameter für die Aktualisierung des Arbeitsbereichs.

options

WorkspaceUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<WorkspaceUpdateResponse>