Product interface

Pakiet:

@azure/arm-apimanagement

Interfejs reprezentujący produkt.

Metody

createOrUpdate(string, string, string, ProductContract, ProductCreateOrUpdateOptionalParams)	Tworzy lub aktualizuje produkt.
delete(string, string, string, string, ProductDeleteOptionalParams)	Usuń produkt.
get(string, string, string, ProductGetOptionalParams)	Pobiera szczegóły produktu określonego przez jego identyfikator.
getEntityTag(string, string, string, ProductGetEntityTagOptionalParams)	Pobiera wersję stanu jednostki (Etag) produktu określonego przez jego identyfikator.
listByService(string, string, ProductListByServiceOptionalParams)	Wyświetla listę kolekcji produktów w określonym wystąpieniu usługi.
listByTags(string, string, ProductListByTagsOptionalParams)	Wyświetla listę kolekcji produktów skojarzonych z tagami.
update(string, string, string, string, ProductUpdateParameters, ProductUpdateOptionalParams)	Zaktualizuj istniejące szczegóły produktu.

Szczegóły metody

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

Tworzy lub aktualizuje produkt.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

productId

string

Identyfikator produktu. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

parameters

ProductContract

Tworzenie lub aktualizowanie parametrów.

options

ProductCreateOrUpdateOptionalParams

Parametry opcji.

Zwraca

Promise<ProductCreateOrUpdateResponse>

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

Usuń produkt.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

productId

string

Identyfikator produktu. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

ifMatch

string

Element ETag jednostki. Element ETag powinien być zgodny z bieżącym stanem jednostki z odpowiedzi nagłówka żądania GET lub powinien być * dla bezwarunkowej aktualizacji.

options

ProductDeleteOptionalParams

Parametry opcji.

Zwraca

Promise<void>

get(string, string, string, ProductGetOptionalParams)

Pobiera szczegóły produktu określonego przez jego identyfikator.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

productId

string

Identyfikator produktu. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

options

ProductGetOptionalParams

Parametry opcji.

Zwraca

Promise<ProductGetResponse>

getEntityTag(string, string, string, ProductGetEntityTagOptionalParams)

Pobiera wersję stanu jednostki (Etag) produktu określonego przez jego identyfikator.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

productId

string

Identyfikator produktu. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

options

ProductGetEntityTagOptionalParams

Parametry opcji.

Zwraca

Promise<ProductGetEntityTagHeaders>

listByService(string, string, ProductListByServiceOptionalParams)

Wyświetla listę kolekcji produktów w określonym wystąpieniu usługi.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

options

ProductListByServiceOptionalParams

Parametry opcji.

Zwraca

PagedAsyncIterableIterator<ProductContract, ProductContract[], PageSettings>

listByTags(string, string, ProductListByTagsOptionalParams)

Wyświetla listę kolekcji produktów skojarzonych z tagami.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

options

ProductListByTagsOptionalParams

Parametry opcji.

Zwraca

PagedAsyncIterableIterator<TagResourceContract, TagResourceContract[], PageSettings>

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

Zaktualizuj istniejące szczegóły produktu.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

productId

string

Identyfikator produktu. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

ifMatch

string

Element ETag jednostki. Element ETag powinien być zgodny z bieżącym stanem jednostki z odpowiedzi nagłówka żądania GET lub powinien być * dla bezwarunkowej aktualizacji.

parameters

ProductUpdateParameters

Aktualizuj parametry.

options

ProductUpdateOptionalParams

Parametry opcji.

Zwraca

Promise<ProductUpdateResponse>