WorkspaceApi interface

Pacote:

@azure/arm-apimanagement

Interface que representa um WorkspaceApi.

Métodos

beginCreateOrUpdate(string, string, string, string, ApiCreateOrUpdateParameter, WorkspaceApiCreateOrUpdateOptionalParams)	Cria novas ou atualiza a API especificada existente do espaço de trabalho em uma instância de serviço de Gerenciamento de API.
beginCreateOrUpdateAndWait(string, string, string, string, ApiCreateOrUpdateParameter, WorkspaceApiCreateOrUpdateOptionalParams)	Cria novas ou atualiza a API especificada existente do espaço de trabalho em uma instância de serviço de Gerenciamento de API.
delete(string, string, string, string, string, WorkspaceApiDeleteOptionalParams)	Exclui a API especificada do espaço de trabalho em uma instância de serviço de Gerenciamento de API.
get(string, string, string, string, WorkspaceApiGetOptionalParams)	Obtém os detalhes da API especificada por seu identificador.
getEntityTag(string, string, string, string, WorkspaceApiGetEntityTagOptionalParams)	Obtém a versão do estado da entidade (Etag) da API especificada por seu identificador.
listByService(string, string, string, WorkspaceApiListByServiceOptionalParams)	Lista todas as APIs do espaço de trabalho em uma instância de serviço de Gerenciamento de API.
update(string, string, string, string, string, ApiUpdateContract, WorkspaceApiUpdateOptionalParams)	Atualiza a API especificada do espaço de trabalho em uma instância de serviço de Gerenciamento de API.

Detalhes de Método

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

Cria novas ou atualiza a API especificada existente do espaço de trabalho em uma instância de serviço de Gerenciamento de API.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço de Gerenciamento de API.

workspaceId

string

Identificador do espaço de trabalho. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.

apiId

string

Identificador de revisão da API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Revisão não corrente tem ; rev=n como sufixo onde n é o número de revisão.

parameters

ApiCreateOrUpdateParameter

Crie ou atualize parâmetros.

options

WorkspaceApiCreateOrUpdateOptionalParams

Os parâmetros de opções.

Devoluções

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

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

Cria novas ou atualiza a API especificada existente do espaço de trabalho em uma instância de serviço de Gerenciamento de API.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço de Gerenciamento de API.

workspaceId

string

Identificador do espaço de trabalho. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.

apiId

string

Identificador de revisão da API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Revisão não corrente tem ; rev=n como sufixo onde n é o número de revisão.

parameters

ApiCreateOrUpdateParameter

Crie ou atualize parâmetros.

options

WorkspaceApiCreateOrUpdateOptionalParams

Os parâmetros de opções.

Devoluções

Promise<WorkspaceApiCreateOrUpdateResponse>

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

Exclui a API especificada do espaço de trabalho em uma instância de serviço de Gerenciamento de API.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço de Gerenciamento de API.

workspaceId

string

Identificador do espaço de trabalho. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.

apiId

string

Identificador de revisão da API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Revisão não corrente tem ; rev=n como sufixo onde n é o número de revisão.

ifMatch

string

ETag da Entidade. O ETag deve corresponder ao estado atual da entidade a partir da resposta do cabeçalho da solicitação GET ou deve ser * para atualização incondicional.

options

WorkspaceApiDeleteOptionalParams

Os parâmetros de opções.

Devoluções

Promise<void>

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

Obtém os detalhes da API especificada por seu identificador.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço de Gerenciamento de API.

workspaceId

string

Identificador do espaço de trabalho. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.

apiId

string

Identificador de revisão da API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Revisão não corrente tem ; rev=n como sufixo onde n é o número de revisão.

options

WorkspaceApiGetOptionalParams

Os parâmetros de opções.

Devoluções

Promise<WorkspaceApiGetResponse>

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

Obtém a versão do estado da entidade (Etag) da API especificada por seu identificador.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço de Gerenciamento de API.

workspaceId

string

Identificador do espaço de trabalho. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.

apiId

string

Identificador de revisão da API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Revisão não corrente tem ; rev=n como sufixo onde n é o número de revisão.

options

WorkspaceApiGetEntityTagOptionalParams

Os parâmetros de opções.

Devoluções

Promise<WorkspaceApiGetEntityTagHeaders>

listByService(string, string, string, WorkspaceApiListByServiceOptionalParams)

Lista todas as APIs do espaço de trabalho em uma instância de serviço de Gerenciamento de API.

function listByService(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceApiListByServiceOptionalParams): PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço de Gerenciamento de API.

workspaceId

string

Identificador do espaço de trabalho. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.

options

WorkspaceApiListByServiceOptionalParams

Os parâmetros de opções.

Devoluções

PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>

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

Atualiza a API especificada do espaço de trabalho em uma instância de serviço de Gerenciamento de API.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço de Gerenciamento de API.

workspaceId

string

Identificador do espaço de trabalho. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.

apiId

string

Identificador de revisão da API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Revisão não corrente tem ; rev=n como sufixo onde n é o número de revisão.

ifMatch

string

ETag da Entidade. O ETag deve corresponder ao estado atual da entidade a partir da resposta do cabeçalho da solicitação GET ou deve ser * para atualização incondicional.

parameters

ApiUpdateContract

Parâmetros do contrato de atualização da API.

options

WorkspaceApiUpdateOptionalParams

Os parâmetros de opções.

Devoluções

Promise<WorkspaceApiUpdateResponse>