Backend interface
Interface que representa um Back-end.
Métodos
| create |
Cria ou Atualizações um back-end. |
| delete(string, string, string, string, Backend |
Elimina o back-end especificado. |
| get(string, string, string, Backend |
Obtém os detalhes do back-end especificado pelo respetivo identificador. |
| get |
Obtém a versão do estado da entidade (Etag) do back-end especificado pelo respetivo identificador. |
| list |
Lista uma coleção de back-ends na instância de serviço especificada. |
| reconnect(string, string, string, Backend |
Notifica o gateway de Gestão de API para criar uma nova ligação ao back-end após o tempo limite especificado. Se não tiver sido especificado nenhum tempo limite, será utilizado o tempo limite de 2 minutos. |
| update(string, string, string, string, Backend |
Atualizações um back-end existente. |
Detalhes de Método
createOrUpdate(string, string, string, BackendContract, BackendCreateOrUpdateOptionalParams)
Cria ou Atualizações um back-end.
function createOrUpdate(resourceGroupName: string, serviceName: string, backendId: string, parameters: BackendContract, options?: BackendCreateOrUpdateOptionalParams): Promise<BackendCreateOrUpdateResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- backendId
-
string
Identificador da entidade back-end. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
- parameters
- BackendContract
Criar parâmetros.
Os parâmetros de opções.
Devoluções
Promise<BackendCreateOrUpdateResponse>
delete(string, string, string, string, BackendDeleteOptionalParams)
Elimina o back-end especificado.
function delete(resourceGroupName: string, serviceName: string, backendId: string, ifMatch: string, options?: BackendDeleteOptionalParams): Promise<void>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- backendId
-
string
Identificador da entidade back-end. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
- ifMatch
-
string
ETag da Entidade. A ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho do pedido GET ou deve ser * para atualização incondicional.
- options
- BackendDeleteOptionalParams
Os parâmetros de opções.
Devoluções
Promise<void>
get(string, string, string, BackendGetOptionalParams)
Obtém os detalhes do back-end especificado pelo respetivo identificador.
function get(resourceGroupName: string, serviceName: string, backendId: string, options?: BackendGetOptionalParams): Promise<BackendGetResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- backendId
-
string
Identificador da entidade back-end. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
- options
- BackendGetOptionalParams
Os parâmetros de opções.
Devoluções
Promise<BackendGetResponse>
getEntityTag(string, string, string, BackendGetEntityTagOptionalParams)
Obtém a versão do estado da entidade (Etag) do back-end especificado pelo respetivo identificador.
function getEntityTag(resourceGroupName: string, serviceName: string, backendId: string, options?: BackendGetEntityTagOptionalParams): Promise<BackendGetEntityTagHeaders>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- backendId
-
string
Identificador da entidade back-end. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
Os parâmetros de opções.
Devoluções
Promise<BackendGetEntityTagHeaders>
listByService(string, string, BackendListByServiceOptionalParams)
Lista uma coleção de back-ends na instância de serviço especificada.
function listByService(resourceGroupName: string, serviceName: string, options?: BackendListByServiceOptionalParams): PagedAsyncIterableIterator<BackendContract, BackendContract[], PageSettings>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
Os parâmetros de opções.
Devoluções
reconnect(string, string, string, BackendReconnectOptionalParams)
Notifica o gateway de Gestão de API para criar uma nova ligação ao back-end após o tempo limite especificado. Se não tiver sido especificado nenhum tempo limite, será utilizado o tempo limite de 2 minutos.
function reconnect(resourceGroupName: string, serviceName: string, backendId: string, options?: BackendReconnectOptionalParams): Promise<void>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- backendId
-
string
Identificador da entidade back-end. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
- options
- BackendReconnectOptionalParams
Os parâmetros de opções.
Devoluções
Promise<void>
update(string, string, string, string, BackendUpdateParameters, BackendUpdateOptionalParams)
Atualizações um back-end existente.
function update(resourceGroupName: string, serviceName: string, backendId: string, ifMatch: string, parameters: BackendUpdateParameters, options?: BackendUpdateOptionalParams): Promise<BackendUpdateResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- backendId
-
string
Identificador da entidade back-end. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
- ifMatch
-
string
ETag da Entidade. A ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho do pedido GET ou deve ser * para atualização incondicional.
- parameters
- BackendUpdateParameters
Atualizar parâmetros.
- options
- BackendUpdateOptionalParams
Os parâmetros de opções.
Devoluções
Promise<BackendUpdateResponse>