Api interface
Interface que representa uma API.
Métodos
Detalhes do método
beginCreateOrUpdate(string, string, string, ApiCreateOrUpdateParameter, ApiCreateOrUpdateOptionalParams)
Cria ou atualiza a API especificada da instância do serviço de Gerenciamento de API.
function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, parameters: ApiCreateOrUpdateParameter, options?: ApiCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ApiCreateOrUpdateResponse>, ApiCreateOrUpdateResponse>>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Gerenciamento de API.
- apiId
-
string
Identificador de revisão de API. Deve ser exclusivo na instância de serviço Gerenciamento de API atual. A revisão não atual tem ;rev=n como um sufixo em que n é o número de revisão.
- parameters
- ApiCreateOrUpdateParameter
Criar ou atualizar parâmetros.
- options
- ApiCreateOrUpdateOptionalParams
Os parâmetros de opções.
Retornos
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiCreateOrUpdateResponse>, ApiCreateOrUpdateResponse>>
beginCreateOrUpdateAndWait(string, string, string, ApiCreateOrUpdateParameter, ApiCreateOrUpdateOptionalParams)
Cria ou atualiza a API especificada da instância do serviço de Gerenciamento de API.
function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, apiId: string, parameters: ApiCreateOrUpdateParameter, options?: ApiCreateOrUpdateOptionalParams): Promise<ApiCreateOrUpdateResponse>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Gerenciamento de API.
- apiId
-
string
Identificador de revisão de API. Deve ser exclusivo na instância de serviço Gerenciamento de API atual. A revisão não atual tem ;rev=n como um sufixo em que n é o número de revisão.
- parameters
- ApiCreateOrUpdateParameter
Criar ou atualizar parâmetros.
- options
- ApiCreateOrUpdateOptionalParams
Os parâmetros de opções.
Retornos
Promise<ApiCreateOrUpdateResponse>
delete(string, string, string, string, ApiDeleteOptionalParams)
Exclui a API especificada da instância do serviço de Gerenciamento de API.
function delete(resourceGroupName: string, serviceName: string, apiId: string, ifMatch: string, options?: ApiDeleteOptionalParams): Promise<void>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Gerenciamento de API.
- apiId
-
string
Identificador de revisão de API. Deve ser exclusivo na instância de serviço Gerenciamento de API atual. A revisão não atual tem ;rev=n como um sufixo em que n é o número de revisão.
- ifMatch
-
string
ETag da Entidade. A ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho da solicitação GET ou deve ser * para atualização incondicional.
- options
- ApiDeleteOptionalParams
Os parâmetros de opções.
Retornos
Promise<void>
get(string, string, string, ApiGetOptionalParams)
Obtém os detalhes da API especificada por seu identificador.
function get(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiGetOptionalParams): Promise<ApiGetResponse>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Gerenciamento de API.
- apiId
-
string
Identificador de revisão de API. Deve ser exclusivo na instância de serviço Gerenciamento de API atual. A revisão não atual tem ;rev=n como um sufixo em que n é o número de revisão.
- options
- ApiGetOptionalParams
Os parâmetros de opções.
Retornos
Promise<ApiGetResponse>
getEntityTag(string, string, string, ApiGetEntityTagOptionalParams)
Obtém a versão Etag (estado de entidade) da API especificada por seu identificador.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiGetEntityTagOptionalParams): Promise<ApiGetEntityTagHeaders>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Gerenciamento de API.
- apiId
-
string
Identificador de revisão de API. Deve ser exclusivo na instância de serviço Gerenciamento de API atual. A revisão não atual tem ;rev=n como um sufixo em que n é o número de revisão.
- options
- ApiGetEntityTagOptionalParams
Os parâmetros de opções.
Retornos
Promise<ApiGetEntityTagHeaders>
listByService(string, string, ApiListByServiceOptionalParams)
Lista todas as APIs da instância do serviço de Gerenciamento de API.
function listByService(resourceGroupName: string, serviceName: string, options?: ApiListByServiceOptionalParams): PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Gerenciamento de API.
- options
- ApiListByServiceOptionalParams
Os parâmetros de opções.
Retornos
listByTags(string, string, ApiListByTagsOptionalParams)
Lista uma coleção de APIs associadas a marcas.
function listByTags(resourceGroupName: string, serviceName: string, options?: ApiListByTagsOptionalParams): PagedAsyncIterableIterator<TagResourceContract, TagResourceContract[], PageSettings>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Gerenciamento de API.
- options
- ApiListByTagsOptionalParams
Os parâmetros de opções.
Retornos
update(string, string, string, string, ApiUpdateContract, ApiUpdateOptionalParams)
Atualizações a API especificada da instância de serviço Gerenciamento de API.
function update(resourceGroupName: string, serviceName: string, apiId: string, ifMatch: string, parameters: ApiUpdateContract, options?: ApiUpdateOptionalParams): Promise<ApiUpdateResponse>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Gerenciamento de API.
- apiId
-
string
Identificador de revisão de API. Deve ser exclusivo na instância de serviço Gerenciamento de API atual. A revisão não atual tem ;rev=n como um sufixo em que n é o número de revisão.
- ifMatch
-
string
ETag da Entidade. A ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho da solicitação GET ou deve ser * para atualização incondicional.
- parameters
- ApiUpdateContract
Parâmetros de Contrato de Atualização de API.
- options
- ApiUpdateOptionalParams
Os parâmetros de opções.
Retornos
Promise<ApiUpdateResponse>