WorkspaceApiOperation interface
Interface représentant une WorkspaceApiOperation.
Méthodes
Détails de la méthode
createOrUpdate(string, string, string, string, string, OperationContract, WorkspaceApiOperationCreateOrUpdateOptionalParams)
Crée une nouvelle opération dans l’API ou la met à jour.
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, operationId: string, parameters: OperationContract, options?: WorkspaceApiOperationCreateOrUpdateOptionalParams): Promise<WorkspaceApiOperationCreateOrUpdateResponse>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- workspaceId
-
string
Identificateur de l’espace de travail. Doit être unique dans l’instance actuelle du service Gestion des API.
- apiId
-
string
Identificateur de révision d’API. Doit être unique dans l’instance actuelle du service Gestion des API. La révision non actuelle a ; rev=n en tant que suffixe où n est le numéro de révision.
- operationId
-
string
Identificateur d’opération dans une API. Doit être unique dans l’instance actuelle du service Gestion des API.
- parameters
- OperationContract
Créez des paramètres.
Paramètres d’options.
Retours
delete(string, string, string, string, string, string, WorkspaceApiOperationDeleteOptionalParams)
Supprime l’opération spécifiée dans l’API.
function delete(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, operationId: string, ifMatch: string, options?: WorkspaceApiOperationDeleteOptionalParams): Promise<void>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- workspaceId
-
string
Identificateur de l’espace de travail. Doit être unique dans l’instance actuelle du service Gestion des API.
- apiId
-
string
Identificateur de révision d’API. Doit être unique dans l’instance actuelle du service Gestion des API. La révision non actuelle a ; rev=n en tant que suffixe où n est le numéro de révision.
- operationId
-
string
Identificateur d’opération dans une API. Doit être unique dans l’instance actuelle du service Gestion des API.
- ifMatch
-
string
ETag de l’entité. ETag doit correspondre à l’état actuel de l’entité à partir de la réponse d’en-tête de la requête GET ou il doit être * pour la mise à jour inconditionnelle.
Paramètres d’options.
Retours
Promise<void>
get(string, string, string, string, string, WorkspaceApiOperationGetOptionalParams)
Obtient les détails de l’opération d’API spécifiée par son identificateur.
function get(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, operationId: string, options?: WorkspaceApiOperationGetOptionalParams): Promise<WorkspaceApiOperationGetResponse>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- workspaceId
-
string
Identificateur de l’espace de travail. Doit être unique dans l’instance actuelle du service Gestion des API.
- apiId
-
string
Identificateur de révision d’API. Doit être unique dans l’instance actuelle du service Gestion des API. La révision non actuelle a ; rev=n en tant que suffixe où n est le numéro de révision.
- operationId
-
string
Identificateur d’opération dans une API. Doit être unique dans l’instance actuelle du service Gestion des API.
Paramètres d’options.
Retours
Promise<WorkspaceApiOperationGetResponse>
getEntityTag(string, string, string, string, string, WorkspaceApiOperationGetEntityTagOptionalParams)
Obtient la version d’état d’entité (Etag) de l’opération d’API spécifiée par son identificateur.
function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, operationId: string, options?: WorkspaceApiOperationGetEntityTagOptionalParams): Promise<WorkspaceApiOperationGetEntityTagHeaders>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- workspaceId
-
string
Identificateur de l’espace de travail. Doit être unique dans l’instance actuelle du service Gestion des API.
- apiId
-
string
Identificateur de révision d’API. Doit être unique dans l’instance actuelle du service Gestion des API. La révision non actuelle a ; rev=n en tant que suffixe où n est le numéro de révision.
- operationId
-
string
Identificateur d’opération dans une API. Doit être unique dans l’instance actuelle du service Gestion des API.
Paramètres d’options.
Retours
listByApi(string, string, string, string, WorkspaceApiOperationListByApiOptionalParams)
Répertorie une collection des opérations pour l’API spécifiée.
function listByApi(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, options?: WorkspaceApiOperationListByApiOptionalParams): PagedAsyncIterableIterator<OperationContract, OperationContract[], PageSettings>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- workspaceId
-
string
Identificateur de l’espace de travail. Doit être unique dans l’instance actuelle du service Gestion des API.
- apiId
-
string
Identificateur de révision d’API. Doit être unique dans l’instance actuelle du service Gestion des API. La révision non actuelle a ; rev=n en tant que suffixe où n est le numéro de révision.
Paramètres d’options.
Retours
update(string, string, string, string, string, string, OperationUpdateContract, WorkspaceApiOperationUpdateOptionalParams)
Met à jour les détails de l’opération dans l’API spécifiée par son identificateur.
function update(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, operationId: string, ifMatch: string, parameters: OperationUpdateContract, options?: WorkspaceApiOperationUpdateOptionalParams): Promise<WorkspaceApiOperationUpdateResponse>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- workspaceId
-
string
Identificateur de l’espace de travail. Doit être unique dans l’instance actuelle du service Gestion des API.
- apiId
-
string
Identificateur de révision d’API. Doit être unique dans l’instance actuelle du service Gestion des API. La révision non actuelle a ; rev=n en tant que suffixe où n est le numéro de révision.
- operationId
-
string
Identificateur d’opération dans une API. Doit être unique dans l’instance actuelle du service Gestion des API.
- ifMatch
-
string
ETag de l’entité. ETag doit correspondre à l’état actuel de l’entité à partir de la réponse d’en-tête de la requête GET ou il doit être * pour la mise à jour inconditionnelle.
- parameters
- OperationUpdateContract
Paramètres de mise à jour des opérations d’API.
Paramètres d’options.
Retours
Promise<WorkspaceApiOperationUpdateResponse>