Workspace interface

Pacote:

@azure/arm-apimanagement

Interface que representa um espaço de trabalho.

Métodos

createOrUpdate(string, string, string, WorkspaceContract, WorkspaceCreateOrUpdateOptionalParams)	Cria um novo espaço de trabalho ou atualiza um existente.
delete(string, string, string, string, WorkspaceDeleteOptionalParams)	Exclui o espaço de trabalho especificado.
get(string, string, string, WorkspaceGetOptionalParams)	Obtém os detalhes do espaço de trabalho especificado por seu identificador.
getEntityTag(string, string, string, WorkspaceGetEntityTagOptionalParams)	Obtém a versão do estado da entidade (Etag) do espaço de trabalho especificado por seu identificador.
listByService(string, string, WorkspaceListByServiceOptionalParams)	Lista todos os espaços de trabalho da instância de serviço de Gerenciamento de API.
update(string, string, string, string, WorkspaceContract, WorkspaceUpdateOptionalParams)	Atualiza os detalhes do espaço de trabalho especificado por seu identificador.

Detalhes de Método

createOrUpdate(string, string, string, WorkspaceContract, WorkspaceCreateOrUpdateOptionalParams)

Cria um novo espaço de trabalho ou atualiza um existente.

function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, parameters: WorkspaceContract, options?: WorkspaceCreateOrUpdateOptionalParams): Promise<WorkspaceCreateOrUpdateResponse>

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.

parameters

WorkspaceContract

Crie parâmetros.

options

WorkspaceCreateOrUpdateOptionalParams

Os parâmetros de opções.

Devoluções

Promise<WorkspaceCreateOrUpdateResponse>

delete(string, string, string, string, WorkspaceDeleteOptionalParams)

Exclui o espaço de trabalho especificado.

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

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

WorkspaceDeleteOptionalParams

Os parâmetros de opções.

Devoluções

Promise<void>

get(string, string, string, WorkspaceGetOptionalParams)

Obtém os detalhes do espaço de trabalho especificado por seu identificador.

function get(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceGetOptionalParams): Promise<WorkspaceGetResponse>

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

WorkspaceGetOptionalParams

Os parâmetros de opções.

Devoluções

Promise<WorkspaceGetResponse>

getEntityTag(string, string, string, WorkspaceGetEntityTagOptionalParams)

Obtém a versão do estado da entidade (Etag) do espaço de trabalho especificado por seu identificador.

function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceGetEntityTagOptionalParams): Promise<WorkspaceGetEntityTagHeaders>

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

WorkspaceGetEntityTagOptionalParams

Os parâmetros de opções.

Devoluções

Promise<WorkspaceGetEntityTagHeaders>

listByService(string, string, WorkspaceListByServiceOptionalParams)

Lista todos os espaços de trabalho da instância de serviço de Gerenciamento de API.

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

options

WorkspaceListByServiceOptionalParams

Os parâmetros de opções.

Devoluções

PagedAsyncIterableIterator<WorkspaceContract, WorkspaceContract[], PageSettings>

update(string, string, string, string, WorkspaceContract, WorkspaceUpdateOptionalParams)

Atualiza os detalhes do espaço de trabalho especificado por seu identificador.

function update(resourceGroupName: string, serviceName: string, workspaceId: string, ifMatch: string, parameters: WorkspaceContract, options?: WorkspaceUpdateOptionalParams): Promise<WorkspaceUpdateResponse>

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.

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

WorkspaceContract

Parâmetros de atualização do espaço de trabalho.

options

WorkspaceUpdateOptionalParams

Os parâmetros de opções.

Devoluções

Promise<WorkspaceUpdateResponse>