ProductApi interface
Interface que representa um ProductApi.
Métodos
| check |
Verifica se a entidade de API especificada pelo identificador está associada à entidade Produto. |
| create |
Adiciona uma API ao produto especificado. |
| delete(string, string, string, string, Product |
Elimina a API especificada do produto especificado. |
| list |
Lista uma coleção de APIs associadas a um produto. |
Detalhes de Método
checkEntityExists(string, string, string, string, ProductApiCheckEntityExistsOptionalParams)
Verifica se a entidade de API especificada pelo identificador está associada à entidade Produto.
function checkEntityExists(resourceGroupName: string, serviceName: string, productId: string, apiId: string, options?: ProductApiCheckEntityExistsOptionalParams): Promise<ProductApiCheckEntityExistsResponse>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.
- productId
-
string
Identificador de produto. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
- apiId
-
string
Identificador de revisão da API. Tem de ser exclusivo na instância de serviço do Gestão de API atual. A revisão não atual tem ;rev=n como um sufixo em que n é o número de revisão.
Os parâmetros de opções.
Devoluções
Promise<ProductApiCheckEntityExistsResponse>
createOrUpdate(string, string, string, string, ProductApiCreateOrUpdateOptionalParams)
Adiciona uma API ao produto especificado.
function createOrUpdate(resourceGroupName: string, serviceName: string, productId: string, apiId: string, options?: ProductApiCreateOrUpdateOptionalParams): Promise<ApiContract>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.
- productId
-
string
Identificador de produto. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
- apiId
-
string
Identificador de revisão da API. Tem de ser exclusivo na instância de serviço do Gestão de API atual. A revisão não atual tem ;rev=n como um sufixo em que n é o número de revisão.
Os parâmetros de opções.
Devoluções
Promise<ApiContract>
delete(string, string, string, string, ProductApiDeleteOptionalParams)
Elimina a API especificada do produto especificado.
function delete(resourceGroupName: string, serviceName: string, productId: string, apiId: string, options?: ProductApiDeleteOptionalParams): 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.
- productId
-
string
Identificador de produto. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
- apiId
-
string
Identificador de revisão da API. Tem de ser exclusivo na instância de serviço do Gestão 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
- ProductApiDeleteOptionalParams
Os parâmetros de opções.
Devoluções
Promise<void>
listByProduct(string, string, string, ProductApiListByProductOptionalParams)
Lista uma coleção de APIs associadas a um produto.
function listByProduct(resourceGroupName: string, serviceName: string, productId: string, options?: ProductApiListByProductOptionalParams): PagedAsyncIterableIterator<ApiContract, ApiContract[], 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.
- productId
-
string
Identificador de produto. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
Os parâmetros de opções.