Sdílet prostřednictvím

ProductApi interface

  • Reference
Balíček:
@azure/arm-apimanagement

Rozhraní představující ProductApi

Metody

checkEntityExists(string, string, string, string, ProductApiCheckEntityExistsOptionalParams)

Kontroluje, že entita rozhraní API zadaná identifikátorem je přidružená k entitě Product.
createOrUpdate(string, string, string, string, ProductApiCreateOrUpdateOptionalParams)

Přidá rozhraní API do zadaného produktu.
delete(string, string, string, string, ProductApiDeleteOptionalParams)

Odstraní zadané rozhraní API ze zadaného produktu.
listByProduct(string, string, string, ProductApiListByProductOptionalParams)

Zobrazí kolekci rozhraní API přidružených k produktu.

Podrobnosti metody

checkEntityExists(string, string, string, string, ProductApiCheckEntityExistsOptionalParams)

Kontroluje, že entita rozhraní API zadaná identifikátorem je přidružená k entitě Product.

function checkEntityExists(resourceGroupName: string, serviceName: string, productId: string, apiId: string, options?: ProductApiCheckEntityExistsOptionalParams): Promise<ProductApiCheckEntityExistsResponse>

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

serviceName

string

Název služby API Management.

productId

string

Identifikátor produktu. V aktuální instanci služby API Management musí být jedinečné.

apiId

string

Identifikátor revize rozhraní API. V aktuální instanci služby API Management musí být jedinečné. Revize, která není aktuální, má ; rev=n jako přípona, kde n je číslo revize.

options
ProductApiCheckEntityExistsOptionalParams

Parametry možností.

Návraty

Promise<ProductApiCheckEntityExistsResponse>

createOrUpdate(string, string, string, string, ProductApiCreateOrUpdateOptionalParams)

Přidá rozhraní API do zadaného produktu.

function createOrUpdate(resourceGroupName: string, serviceName: string, productId: string, apiId: string, options?: ProductApiCreateOrUpdateOptionalParams): Promise<ApiContract>

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

serviceName

string

Název služby API Management.

productId

string

Identifikátor produktu. V aktuální instanci služby API Management musí být jedinečné.

apiId

string

Identifikátor revize rozhraní API. V aktuální instanci služby API Management musí být jedinečné. Revize, která není aktuální, má ; rev=n jako přípona, kde n je číslo revize.

options
ProductApiCreateOrUpdateOptionalParams

Parametry možností.

Návraty

Promise<ApiContract>

delete(string, string, string, string, ProductApiDeleteOptionalParams)

Odstraní zadané rozhraní API ze zadaného produktu.

function delete(resourceGroupName: string, serviceName: string, productId: string, apiId: string, options?: ProductApiDeleteOptionalParams): Promise<void>

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

serviceName

string

Název služby API Management.

productId

string

Identifikátor produktu. V aktuální instanci služby API Management musí být jedinečné.

apiId

string

Identifikátor revize rozhraní API. V aktuální instanci služby API Management musí být jedinečné. Revize, která není aktuální, má ; rev=n jako přípona, kde n je číslo revize.

options
ProductApiDeleteOptionalParams

Parametry možností.

Návraty

Promise<void>

listByProduct(string, string, string, ProductApiListByProductOptionalParams)

Zobrazí kolekci rozhraní API přidružených k produktu.

function listByProduct(resourceGroupName: string, serviceName: string, productId: string, options?: ProductApiListByProductOptionalParams): PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

serviceName

string

Název služby API Management.

productId

string

Identifikátor produktu. V aktuální instanci služby API Management musí být jedinečné.

options
ProductApiListByProductOptionalParams

Parametry možností.

Návraty

PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>