WorkspaceApi interface
Schnittstelle, die eine WorkspaceApi darstellt.
Methoden
Details zur Methode
beginCreateOrUpdate(string, string, string, string, ApiCreateOrUpdateParameter, WorkspaceApiCreateOrUpdateOptionalParams)
Erstellt neue oder aktualisiert vorhandene angegebene API des Arbeitsbereichs in einer API-Verwaltungsdienstinstanz.
function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, parameters: ApiCreateOrUpdateParameter, options?: WorkspaceApiCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<WorkspaceApiCreateOrUpdateResponse>, WorkspaceApiCreateOrUpdateResponse>>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.
- apiId
-
string
API-Revisionsbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein. Die nicht aktuelle Überarbeitung hat ; rev=n als Suffix, wobei n die Revisionsnummer ist.
- parameters
- ApiCreateOrUpdateParameter
Erstellen oder Aktualisieren von Parametern.
Die Optionsparameter.
Gibt zurück
Promise<@azure/core-lro.SimplePollerLike<OperationState<WorkspaceApiCreateOrUpdateResponse>, WorkspaceApiCreateOrUpdateResponse>>
beginCreateOrUpdateAndWait(string, string, string, string, ApiCreateOrUpdateParameter, WorkspaceApiCreateOrUpdateOptionalParams)
Erstellt neue oder aktualisiert vorhandene angegebene API des Arbeitsbereichs in einer API-Verwaltungsdienstinstanz.
function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, parameters: ApiCreateOrUpdateParameter, options?: WorkspaceApiCreateOrUpdateOptionalParams): Promise<WorkspaceApiCreateOrUpdateResponse>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.
- apiId
-
string
API-Revisionsbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein. Die nicht aktuelle Überarbeitung hat ; rev=n als Suffix, wobei n die Revisionsnummer ist.
- parameters
- ApiCreateOrUpdateParameter
Erstellen oder Aktualisieren von Parametern.
Die Optionsparameter.
Gibt zurück
Promise<WorkspaceApiCreateOrUpdateResponse>
delete(string, string, string, string, string, WorkspaceApiDeleteOptionalParams)
Löscht die angegebene API des Arbeitsbereichs in einer API-Verwaltungsdienstinstanz.
function delete(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, ifMatch: string, options?: WorkspaceApiDeleteOptionalParams): 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.
- apiId
-
string
API-Revisionsbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein. Die nicht aktuelle Überarbeitung hat ; rev=n als Suffix, wobei n die Revisionsnummer ist.
- 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
- WorkspaceApiDeleteOptionalParams
Die Optionsparameter.
Gibt zurück
Promise<void>
get(string, string, string, string, WorkspaceApiGetOptionalParams)
Ruft die Details der API ab, die durch den Bezeichner angegeben ist.
function get(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, options?: WorkspaceApiGetOptionalParams): Promise<WorkspaceApiGetResponse>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.
- apiId
-
string
API-Revisionsbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein. Die nicht aktuelle Überarbeitung hat ; rev=n als Suffix, wobei n die Revisionsnummer ist.
- options
- WorkspaceApiGetOptionalParams
Die Optionsparameter.
Gibt zurück
Promise<WorkspaceApiGetResponse>
getEntityTag(string, string, string, string, WorkspaceApiGetEntityTagOptionalParams)
Ruft die Entitätsstatusversion (Etag) der API ab, die durch den Bezeichner angegeben ist.
function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, options?: WorkspaceApiGetEntityTagOptionalParams): Promise<WorkspaceApiGetEntityTagHeaders>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.
- apiId
-
string
API-Revisionsbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein. Die nicht aktuelle Überarbeitung hat ; rev=n als Suffix, wobei n die Revisionsnummer ist.
Die Optionsparameter.
Gibt zurück
Promise<WorkspaceApiGetEntityTagHeaders>
listByService(string, string, string, WorkspaceApiListByServiceOptionalParams)
Listet alle APIs des Arbeitsbereichs in einer API-Verwaltungsdienstinstanz auf.
function listByService(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceApiListByServiceOptionalParams): PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>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.
Die Optionsparameter.
Gibt zurück
update(string, string, string, string, string, ApiUpdateContract, WorkspaceApiUpdateOptionalParams)
Aktualisiert die angegebene API des Arbeitsbereichs in einer API-Verwaltungsdienstinstanz.
function update(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, ifMatch: string, parameters: ApiUpdateContract, options?: WorkspaceApiUpdateOptionalParams): Promise<WorkspaceApiUpdateResponse>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.
- apiId
-
string
API-Revisionsbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein. Die nicht aktuelle Überarbeitung hat ; rev=n als Suffix, wobei n die Revisionsnummer ist.
- 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
- ApiUpdateContract
API Update Contract-Parameter.
- options
- WorkspaceApiUpdateOptionalParams
Die Optionsparameter.
Gibt zurück
Promise<WorkspaceApiUpdateResponse>