WorkspaceBackend interface
Interface que representa um WorkspaceBackend.
Métodos
| create |
Cria ou atualiza um back-end. |
| delete(string, string, string, string, string, Workspace |
Exclui o back-end especificado. |
| get(string, string, string, string, Workspace |
Obtém os detalhes do back-end especificado por seu identificador. |
| get |
Obtém a versão do estado da entidade (Etag) do back-end especificado por seu identificador. |
| list |
Lista uma coleção de back-ends no espaço de trabalho especificado. |
| update(string, string, string, string, string, Backend |
Atualiza um back-end existente. |
Detalhes de Método
createOrUpdate(string, string, string, string, BackendContract, WorkspaceBackendCreateOrUpdateOptionalParams)
Cria ou atualiza um back-end.
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, backendId: string, parameters: BackendContract, options?: WorkspaceBackendCreateOrUpdateOptionalParams): Promise<WorkspaceBackendCreateOrUpdateResponse>
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.
- backendId
-
string
Identificador da entidade Back-end. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
- parameters
- BackendContract
Crie parâmetros.
Os parâmetros de opções.
Devoluções
delete(string, string, string, string, string, WorkspaceBackendDeleteOptionalParams)
Exclui o back-end especificado.
function delete(resourceGroupName: string, serviceName: string, workspaceId: string, backendId: string, ifMatch: string, options?: WorkspaceBackendDeleteOptionalParams): 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.
- backendId
-
string
Identificador da entidade Back-end. 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.
Os parâmetros de opções.
Devoluções
Promise<void>
get(string, string, string, string, WorkspaceBackendGetOptionalParams)
Obtém os detalhes do back-end especificado por seu identificador.
function get(resourceGroupName: string, serviceName: string, workspaceId: string, backendId: string, options?: WorkspaceBackendGetOptionalParams): Promise<WorkspaceBackendGetResponse>
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.
- backendId
-
string
Identificador da entidade Back-end. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
Os parâmetros de opções.
Devoluções
Promise<WorkspaceBackendGetResponse>
getEntityTag(string, string, string, string, WorkspaceBackendGetEntityTagOptionalParams)
Obtém a versão do estado da entidade (Etag) do back-end especificado por seu identificador.
function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, backendId: string, options?: WorkspaceBackendGetEntityTagOptionalParams): Promise<WorkspaceBackendGetEntityTagHeaders>
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.
- backendId
-
string
Identificador da entidade Back-end. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
Os parâmetros de opções.
Devoluções
Promise<WorkspaceBackendGetEntityTagHeaders>
listByWorkspace(string, string, string, WorkspaceBackendListByWorkspaceOptionalParams)
Lista uma coleção de back-ends no espaço de trabalho especificado.
function listByWorkspace(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceBackendListByWorkspaceOptionalParams): PagedAsyncIterableIterator<BackendContract, BackendContract[], 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.
Os parâmetros de opções.
Devoluções
update(string, string, string, string, string, BackendUpdateParameters, WorkspaceBackendUpdateOptionalParams)
Atualiza um back-end existente.
function update(resourceGroupName: string, serviceName: string, workspaceId: string, backendId: string, ifMatch: string, parameters: BackendUpdateParameters, options?: WorkspaceBackendUpdateOptionalParams): Promise<WorkspaceBackendUpdateResponse>
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.
- backendId
-
string
Identificador da entidade Back-end. 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
- BackendUpdateParameters
Atualizar parâmetros.
Os parâmetros de opções.
Devoluções
Promise<WorkspaceBackendUpdateResponse>