ProductApi interface
Interfaccia che rappresenta un productApi.
Metodi
| check |
Verifica che l'entità API specificata dall'identificatore sia associata all'entità Product. |
| create |
Aggiunge un'API al prodotto specificato. |
| delete(string, string, string, string, Product |
Elimina l'API specificata dal prodotto specificato. |
| list |
Elenca una raccolta delle API associate a un prodotto. |
Dettagli metodo
checkEntityExists(string, string, string, string, ProductApiCheckEntityExistsOptionalParams)
Verifica che l'entità API specificata dall'identificatore sia associata all'entità Product.
function checkEntityExists(resourceGroupName: string, serviceName: string, productId: string, apiId: string, options?: ProductApiCheckEntityExistsOptionalParams): Promise<ProductApiCheckEntityExistsResponse>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
- serviceName
-
string
Nome del servizio di Gestione API.
- productId
-
string
Identificatore prodotto. Deve essere univoco nell'istanza corrente del servizio di Gestione API.
- apiId
-
string
Identificatore di revisione DELL'API. Deve essere univoco nell'istanza corrente del servizio di Gestione API. La revisione non corrente include ;rev=n come suffisso dove n è il numero di revisione.
Parametri delle opzioni.
Restituisce
Promise<ProductApiCheckEntityExistsResponse>
createOrUpdate(string, string, string, string, ProductApiCreateOrUpdateOptionalParams)
Aggiunge un'API al prodotto specificato.
function createOrUpdate(resourceGroupName: string, serviceName: string, productId: string, apiId: string, options?: ProductApiCreateOrUpdateOptionalParams): Promise<ApiContract>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
- serviceName
-
string
Nome del servizio di Gestione API.
- productId
-
string
Identificatore prodotto. Deve essere univoco nell'istanza corrente del servizio di Gestione API.
- apiId
-
string
Identificatore di revisione DELL'API. Deve essere univoco nell'istanza corrente del servizio di Gestione API. La revisione non corrente include ;rev=n come suffisso dove n è il numero di revisione.
Parametri delle opzioni.
Restituisce
Promise<ApiContract>
delete(string, string, string, string, ProductApiDeleteOptionalParams)
Elimina l'API specificata dal prodotto specificato.
function delete(resourceGroupName: string, serviceName: string, productId: string, apiId: string, options?: ProductApiDeleteOptionalParams): Promise<void>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
- serviceName
-
string
Nome del servizio di Gestione API.
- productId
-
string
Identificatore prodotto. Deve essere univoco nell'istanza corrente del servizio di Gestione API.
- apiId
-
string
Identificatore di revisione DELL'API. Deve essere univoco nell'istanza corrente del servizio di Gestione API. La revisione non corrente include ;rev=n come suffisso dove n è il numero di revisione.
- options
- ProductApiDeleteOptionalParams
Parametri delle opzioni.
Restituisce
Promise<void>
listByProduct(string, string, string, ProductApiListByProductOptionalParams)
Elenca una raccolta delle API associate a un prodotto.
function listByProduct(resourceGroupName: string, serviceName: string, productId: string, options?: ProductApiListByProductOptionalParams): PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
- serviceName
-
string
Nome del servizio di Gestione API.
- productId
-
string
Identificatore prodotto. Deve essere univoco nell'istanza corrente del servizio di Gestione API.
Parametri delle opzioni.