WorkspaceApiOperation interface
Schnittstelle, die eine WorkspaceApiOperation darstellt.
Methoden
Details zur Methode
createOrUpdate(string, string, string, string, string, OperationContract, WorkspaceApiOperationCreateOrUpdateOptionalParams)
Erstellt einen neuen Vorgang in der API oder aktualisiert einen bereits vorhandenen
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, operationId: string, parameters: OperationContract, options?: WorkspaceApiOperationCreateOrUpdateOptionalParams): Promise<WorkspaceApiOperationCreateOrUpdateResponse>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.
- operationId
-
string
Vorgangsbezeichner innerhalb einer API. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.
- parameters
- OperationContract
Erstellen Sie Parameter.
Die Optionsparameter.
Gibt zurück
delete(string, string, string, string, string, string, WorkspaceApiOperationDeleteOptionalParams)
Löscht den angegebenen Vorgang aus der API
function delete(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, operationId: string, ifMatch: string, options?: WorkspaceApiOperationDeleteOptionalParams): 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.
- operationId
-
string
Vorgangsbezeichner innerhalb einer API. 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.
Die Optionsparameter.
Gibt zurück
Promise<void>
get(string, string, string, string, string, WorkspaceApiOperationGetOptionalParams)
Ruft die Details des API-Vorgangs ab, der durch seinen Bezeichner angegeben wird.
function get(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, operationId: string, options?: WorkspaceApiOperationGetOptionalParams): Promise<WorkspaceApiOperationGetResponse>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.
- operationId
-
string
Vorgangsbezeichner innerhalb einer API. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.
Die Optionsparameter.
Gibt zurück
Promise<WorkspaceApiOperationGetResponse>
getEntityTag(string, string, string, string, string, WorkspaceApiOperationGetEntityTagOptionalParams)
Ruft die Entitätsstatusversion (Etag) des durch seinen Bezeichner angegebenen API-Vorgangs ab.
function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, operationId: string, options?: WorkspaceApiOperationGetEntityTagOptionalParams): Promise<WorkspaceApiOperationGetEntityTagHeaders>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.
- operationId
-
string
Vorgangsbezeichner innerhalb einer API. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.
Die Optionsparameter.
Gibt zurück
listByApi(string, string, string, string, WorkspaceApiOperationListByApiOptionalParams)
Listet eine Auflistung der Vorgänge für die angegebene API auf
function listByApi(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, options?: WorkspaceApiOperationListByApiOptionalParams): PagedAsyncIterableIterator<OperationContract, OperationContract[], 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.
- 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
update(string, string, string, string, string, string, OperationUpdateContract, WorkspaceApiOperationUpdateOptionalParams)
Aktualisiert die Details des Vorgangs in der api, die durch den Bezeichner angegeben wird.
function update(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, operationId: string, ifMatch: string, parameters: OperationUpdateContract, options?: WorkspaceApiOperationUpdateOptionalParams): Promise<WorkspaceApiOperationUpdateResponse>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.
- operationId
-
string
Vorgangsbezeichner innerhalb einer API. 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
- OperationUpdateContract
API Operation Update-Parameter.
Die Optionsparameter.
Gibt zurück
Promise<WorkspaceApiOperationUpdateResponse>