WorkspaceProduct interface
Interfejs reprezentujący element WorkspaceProduct.
Metody
| create |
Tworzy lub aktualizuje produkt. |
| delete(string, string, string, string, string, Workspace |
Usuń produkt. |
| get(string, string, string, string, Workspace |
Pobiera szczegóły produktu określonego przez jego identyfikator. |
| get |
Pobiera wersję stanu jednostki (Etag) produktu określonego przez jego identyfikator. |
| list |
Wyświetla listę kolekcji produktów w określonym obszarze roboczym w wystąpieniu usługi. |
| update(string, string, string, string, string, Product |
Zaktualizuj istniejące szczegóły produktu. |
Szczegóły metody
createOrUpdate(string, string, string, string, ProductContract, WorkspaceProductCreateOrUpdateOptionalParams)
Tworzy lub aktualizuje produkt.
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, productId: string, parameters: ProductContract, options?: WorkspaceProductCreateOrUpdateOptionalParams): Promise<WorkspaceProductCreateOrUpdateResponse>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- workspaceId
-
string
Identyfikator obszaru roboczego. Musi być unikatowa w bieżącym wystąpieniu 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.
Parametry opcji.
Zwraca
delete(string, string, string, string, string, WorkspaceProductDeleteOptionalParams)
Usuń produkt.
function delete(resourceGroupName: string, serviceName: string, workspaceId: string, productId: string, ifMatch: string, options?: WorkspaceProductDeleteOptionalParams): Promise<void>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- workspaceId
-
string
Identyfikator obszaru roboczego. Musi być unikatowa w bieżącym wystąpieniu 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.
Parametry opcji.
Zwraca
Promise<void>
get(string, string, string, string, WorkspaceProductGetOptionalParams)
Pobiera szczegóły produktu określonego przez jego identyfikator.
function get(resourceGroupName: string, serviceName: string, workspaceId: string, productId: string, options?: WorkspaceProductGetOptionalParams): Promise<WorkspaceProductGetResponse>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- workspaceId
-
string
Identyfikator obszaru roboczego. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
- productId
-
string
Identyfikator produktu. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
Parametry opcji.
Zwraca
Promise<WorkspaceProductGetResponse>
getEntityTag(string, string, string, string, WorkspaceProductGetEntityTagOptionalParams)
Pobiera wersję stanu jednostki (Etag) produktu określonego przez jego identyfikator.
function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, productId: string, options?: WorkspaceProductGetEntityTagOptionalParams): Promise<WorkspaceProductGetEntityTagHeaders>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- workspaceId
-
string
Identyfikator obszaru roboczego. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
- productId
-
string
Identyfikator produktu. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
Parametry opcji.
Zwraca
Promise<WorkspaceProductGetEntityTagHeaders>
listByService(string, string, string, WorkspaceProductListByServiceOptionalParams)
Wyświetla listę kolekcji produktów w określonym obszarze roboczym w wystąpieniu usługi.
function listByService(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceProductListByServiceOptionalParams): 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.
- workspaceId
-
string
Identyfikator obszaru roboczego. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
Parametry opcji.
Zwraca
update(string, string, string, string, string, ProductUpdateParameters, WorkspaceProductUpdateOptionalParams)
Zaktualizuj istniejące szczegóły produktu.
function update(resourceGroupName: string, serviceName: string, workspaceId: string, productId: string, ifMatch: string, parameters: ProductUpdateParameters, options?: WorkspaceProductUpdateOptionalParams): Promise<WorkspaceProductUpdateResponse>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- workspaceId
-
string
Identyfikator obszaru roboczego. Musi być unikatowa w bieżącym wystąpieniu 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.
Parametry opcji.
Zwraca
Promise<WorkspaceProductUpdateResponse>