WorkspaceApi interface

Paquet:

@azure/arm-apimanagement

Interface représentant une WorkspaceApi.

Méthodes

beginCreateOrUpdate(string, string, string, string, ApiCreateOrUpdateParameter, WorkspaceApiCreateOrUpdateOptionalParams)	Crée ou met à jour une API spécifiée existante de l’espace de travail dans une instance de service Gestion des API.
beginCreateOrUpdateAndWait(string, string, string, string, ApiCreateOrUpdateParameter, WorkspaceApiCreateOrUpdateOptionalParams)	Crée ou met à jour une API spécifiée existante de l’espace de travail dans une instance de service Gestion des API.
delete(string, string, string, string, string, WorkspaceApiDeleteOptionalParams)	Supprime l’API spécifiée de l’espace de travail dans une instance de service Gestion des API.
get(string, string, string, string, WorkspaceApiGetOptionalParams)	Obtient les détails de l’API spécifiée par son identificateur.
getEntityTag(string, string, string, string, WorkspaceApiGetEntityTagOptionalParams)	Obtient la version d’état d’entité (Etag) de l’API spécifiée par son identificateur.
listByService(string, string, string, WorkspaceApiListByServiceOptionalParams)	Répertorie toutes les API de l’espace de travail dans une instance de service Gestion des API.
update(string, string, string, string, string, ApiUpdateContract, WorkspaceApiUpdateOptionalParams)	Met à jour l’API spécifiée de l’espace de travail dans une instance de service Gestion des API.

Détails de la méthode

beginCreateOrUpdate(string, string, string, string, ApiCreateOrUpdateParameter, WorkspaceApiCreateOrUpdateOptionalParams)

Crée ou met à jour une API spécifiée existante de l’espace de travail dans une instance de service Gestion des API.

function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, parameters: ApiCreateOrUpdateParameter, options?: WorkspaceApiCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<WorkspaceApiCreateOrUpdateResponse>, WorkspaceApiCreateOrUpdateResponse>>

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.

parameters

ApiCreateOrUpdateParameter

Créez ou mettez à jour des paramètres.

options

WorkspaceApiCreateOrUpdateOptionalParams

Paramètres d’options.

Retours

Promise<@azure/core-lro.SimplePollerLike<OperationState<WorkspaceApiCreateOrUpdateResponse>, WorkspaceApiCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait(string, string, string, string, ApiCreateOrUpdateParameter, WorkspaceApiCreateOrUpdateOptionalParams)

Crée ou met à jour une API spécifiée existante de l’espace de travail dans une instance de service Gestion des API.

function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, parameters: ApiCreateOrUpdateParameter, options?: WorkspaceApiCreateOrUpdateOptionalParams): Promise<WorkspaceApiCreateOrUpdateResponse>

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.

parameters

ApiCreateOrUpdateParameter

Créez ou mettez à jour des paramètres.

options

WorkspaceApiCreateOrUpdateOptionalParams

Paramètres d’options.

Retours

Promise<WorkspaceApiCreateOrUpdateResponse>

delete(string, string, string, string, string, WorkspaceApiDeleteOptionalParams)

Supprime l’API spécifiée de l’espace de travail dans une instance de service Gestion des API.

function delete(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, ifMatch: string, options?: WorkspaceApiDeleteOptionalParams): 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.

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.

options

WorkspaceApiDeleteOptionalParams

Paramètres d’options.

Retours

Promise<void>

get(string, string, string, string, WorkspaceApiGetOptionalParams)

Obtient les détails de l’API spécifiée par son identificateur.

function get(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, options?: WorkspaceApiGetOptionalParams): Promise<WorkspaceApiGetResponse>

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.

options

WorkspaceApiGetOptionalParams

Paramètres d’options.

Retours

Promise<WorkspaceApiGetResponse>

getEntityTag(string, string, string, string, WorkspaceApiGetEntityTagOptionalParams)

Obtient la version d’état d’entité (Etag) de l’API spécifiée par son identificateur.

function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, options?: WorkspaceApiGetEntityTagOptionalParams): Promise<WorkspaceApiGetEntityTagHeaders>

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.

options

WorkspaceApiGetEntityTagOptionalParams

Paramètres d’options.

Retours

Promise<WorkspaceApiGetEntityTagHeaders>

listByService(string, string, string, WorkspaceApiListByServiceOptionalParams)

Répertorie toutes les API de l’espace de travail dans une instance de service Gestion des API.

function listByService(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceApiListByServiceOptionalParams): PagedAsyncIterableIterator<ApiContract, ApiContract[], 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.

options

WorkspaceApiListByServiceOptionalParams

Paramètres d’options.

Retours

PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>

update(string, string, string, string, string, ApiUpdateContract, WorkspaceApiUpdateOptionalParams)

Met à jour l’API spécifiée de l’espace de travail dans une instance de service Gestion des API.

function update(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, ifMatch: string, parameters: ApiUpdateContract, options?: WorkspaceApiUpdateOptionalParams): Promise<WorkspaceApiUpdateResponse>

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.

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

ApiUpdateContract

Paramètres du contrat de mise à jour de l’API.

options

WorkspaceApiUpdateOptionalParams

Paramètres d’options.

Retours

Promise<WorkspaceApiUpdateResponse>