Product interface

Paket:

@azure/arm-apimanagement

Gränssnitt som representerar en produkt.

Metoder

createOrUpdate(string, string, string, ProductContract, ProductCreateOrUpdateOptionalParams)	Skapar eller Uppdateringar en produkt.
delete(string, string, string, string, ProductDeleteOptionalParams)	Ta bort produkt.
get(string, string, string, ProductGetOptionalParams)	Hämtar information om produkten som anges av dess identifierare.
getEntityTag(string, string, string, ProductGetEntityTagOptionalParams)	Hämtar entitetstillståndsversionen (Etag) för produkten som anges av dess identifierare.
listByService(string, string, ProductListByServiceOptionalParams)	Visar en samling produkter i den angivna tjänstinstansen.
listByTags(string, string, ProductListByTagsOptionalParams)	Visar en samling produkter som är associerade med taggar.
update(string, string, string, string, ProductUpdateParameters, ProductUpdateOptionalParams)	Uppdatera befintlig produktinformation.

Metodinformation

createOrUpdate(string, string, string, ProductContract, ProductCreateOrUpdateOptionalParams)

Skapar eller Uppdateringar en produkt.

function createOrUpdate(resourceGroupName: string, serviceName: string, productId: string, parameters: ProductContract, options?: ProductCreateOrUpdateOptionalParams): Promise<ProductCreateOrUpdateResponse>

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

productId

string

Produktidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.

parameters

ProductContract

Skapa eller uppdatera parametrar.

options

ProductCreateOrUpdateOptionalParams

Alternativparametrarna.

Returer

Promise<ProductCreateOrUpdateResponse>

delete(string, string, string, string, ProductDeleteOptionalParams)

Ta bort produkt.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

productId

string

Produktidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.

ifMatch

string

ETag för entiteten. ETag ska matcha det aktuella entitetstillståndet från huvudsvaret för GET-begäran, eller så bör det vara * för ovillkorlig uppdatering.

options

ProductDeleteOptionalParams

Alternativparametrarna.

Returer

Promise<void>

get(string, string, string, ProductGetOptionalParams)

Hämtar information om produkten som anges av dess identifierare.

function get(resourceGroupName: string, serviceName: string, productId: string, options?: ProductGetOptionalParams): Promise<ProductGetResponse>

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

productId

string

Produktidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.

options

ProductGetOptionalParams

Alternativparametrarna.

Returer

Promise<ProductGetResponse>

getEntityTag(string, string, string, ProductGetEntityTagOptionalParams)

Hämtar entitetstillståndsversionen (Etag) för produkten som anges av dess identifierare.

function getEntityTag(resourceGroupName: string, serviceName: string, productId: string, options?: ProductGetEntityTagOptionalParams): Promise<ProductGetEntityTagHeaders>

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

productId

string

Produktidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.

options

ProductGetEntityTagOptionalParams

Alternativparametrarna.

Returer

Promise<ProductGetEntityTagHeaders>

listByService(string, string, ProductListByServiceOptionalParams)

Visar en samling produkter i den angivna tjänstinstansen.

function listByService(resourceGroupName: string, serviceName: string, options?: ProductListByServiceOptionalParams): PagedAsyncIterableIterator<ProductContract, ProductContract[], PageSettings>

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

options

ProductListByServiceOptionalParams

Alternativparametrarna.

Returer

PagedAsyncIterableIterator<ProductContract, ProductContract[], PageSettings>

listByTags(string, string, ProductListByTagsOptionalParams)

Visar en samling produkter som är associerade med taggar.

function listByTags(resourceGroupName: string, serviceName: string, options?: ProductListByTagsOptionalParams): PagedAsyncIterableIterator<TagResourceContract, TagResourceContract[], PageSettings>

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

options

ProductListByTagsOptionalParams

Alternativparametrarna.

Returer

PagedAsyncIterableIterator<TagResourceContract, TagResourceContract[], PageSettings>

update(string, string, string, string, ProductUpdateParameters, ProductUpdateOptionalParams)

Uppdatera befintlig produktinformation.

function update(resourceGroupName: string, serviceName: string, productId: string, ifMatch: string, parameters: ProductUpdateParameters, options?: ProductUpdateOptionalParams): Promise<ProductUpdateResponse>

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

productId

string

Produktidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.

ifMatch

string

ETag för entiteten. ETag ska matcha det aktuella entitetstillståndet från huvudsvaret för GET-begäran, eller så bör det vara * för ovillkorlig uppdatering.

parameters

ProductUpdateParameters

Uppdatera parametrar.

options

ProductUpdateOptionalParams

Alternativparametrarna.

Returer

Promise<ProductUpdateResponse>