ApiIssue interface
Interface que representa uma ApiIssue.
Métodos
| create |
Cria um novo Problema para uma API ou atualiza um existente. |
| delete(string, string, string, string, string, Api |
Elimina o Problema especificado de uma API. |
| get(string, string, string, string, Api |
Obtém os detalhes do Problema de uma API especificada pelo respetivo identificador. |
| get |
Obtém a versão do estado da entidade (Etag) do Problema de uma API especificada pelo respetivo identificador. |
| list |
Lista todos os problemas associados à API especificada. |
| update(string, string, string, string, string, Issue |
Atualizações um problema existente para uma API. |
Detalhes de Método
createOrUpdate(string, string, string, string, IssueContract, ApiIssueCreateOrUpdateOptionalParams)
Cria um novo Problema para uma API ou atualiza um existente.
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, parameters: IssueContract, options?: ApiIssueCreateOrUpdateOptionalParams): Promise<ApiIssueCreateOrUpdateResponse>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.
- apiId
-
string
Identificador de API. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
- issueId
-
string
Identificador do problema. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
- parameters
- IssueContract
Criar parâmetros.
Os parâmetros de opções.
Devoluções
Promise<ApiIssueCreateOrUpdateResponse>
delete(string, string, string, string, string, ApiIssueDeleteOptionalParams)
Elimina o Problema especificado de uma API.
function delete(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, ifMatch: string, options?: ApiIssueDeleteOptionalParams): 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.
- apiId
-
string
Identificador de API. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
- issueId
-
string
Identificador do problema. 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
- ApiIssueDeleteOptionalParams
Os parâmetros de opções.
Devoluções
Promise<void>
get(string, string, string, string, ApiIssueGetOptionalParams)
Obtém os detalhes do Problema de uma API especificada pelo respetivo identificador.
function get(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, options?: ApiIssueGetOptionalParams): Promise<ApiIssueGetResponse>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.
- apiId
-
string
Identificador de API. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
- issueId
-
string
Identificador do problema. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
- options
- ApiIssueGetOptionalParams
Os parâmetros de opções.
Devoluções
Promise<ApiIssueGetResponse>
getEntityTag(string, string, string, string, ApiIssueGetEntityTagOptionalParams)
Obtém a versão do estado da entidade (Etag) do Problema de uma API especificada pelo respetivo identificador.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, options?: ApiIssueGetEntityTagOptionalParams): Promise<ApiIssueGetEntityTagHeaders>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.
- apiId
-
string
Identificador de API. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
- issueId
-
string
Identificador do problema. 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<ApiIssueGetEntityTagHeaders>
listByService(string, string, string, ApiIssueListByServiceOptionalParams)
Lista todos os problemas associados à API especificada.
function listByService(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiIssueListByServiceOptionalParams): PagedAsyncIterableIterator<IssueContract, IssueContract[], 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.
- apiId
-
string
Identificador de API. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
Os parâmetros de opções.
Devoluções
update(string, string, string, string, string, IssueUpdateContract, ApiIssueUpdateOptionalParams)
Atualizações um problema existente para uma API.
function update(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, ifMatch: string, parameters: IssueUpdateContract, options?: ApiIssueUpdateOptionalParams): Promise<ApiIssueUpdateResponse>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.
- apiId
-
string
Identificador de API. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
- issueId
-
string
Identificador do problema. 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
- IssueUpdateContract
Atualizar parâmetros.
- options
- ApiIssueUpdateOptionalParams
Os parâmetros de opções.
Devoluções
Promise<ApiIssueUpdateResponse>