WorkspaceProductApiLink interface
Interfejs reprezentujący element WorkspaceProductApiLink.
Metody
| create |
Dodaje interfejs API do określonego produktu za pośrednictwem linku. |
| delete(string, string, string, string, string, Workspace |
Usuwa określony interfejs API z określonego produktu. |
| get(string, string, string, string, string, Workspace |
Pobiera link interfejsu API dla produktu. |
| list |
Wyświetla listę kolekcji łączy interfejsu API skojarzonych z produktem. |
Szczegóły metody
createOrUpdate(string, string, string, string, string, ProductApiLinkContract, WorkspaceProductApiLinkCreateOrUpdateOptionalParams)
Dodaje interfejs API do określonego produktu za pośrednictwem linku.
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, productId: string, apiLinkId: string, parameters: ProductApiLinkContract, options?: WorkspaceProductApiLinkCreateOrUpdateOptionalParams): Promise<ProductApiLinkContract>
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.
- apiLinkId
-
string
Product-API identyfikator łącza. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
- parameters
- ProductApiLinkContract
Tworzenie lub aktualizowanie parametrów.
Parametry opcji.
Zwraca
Promise<ProductApiLinkContract>
delete(string, string, string, string, string, WorkspaceProductApiLinkDeleteOptionalParams)
Usuwa określony interfejs API z określonego produktu.
function delete(resourceGroupName: string, serviceName: string, workspaceId: string, productId: string, apiLinkId: string, options?: WorkspaceProductApiLinkDeleteOptionalParams): 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.
- apiLinkId
-
string
Product-API identyfikator łącza. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
Parametry opcji.
Zwraca
Promise<void>
get(string, string, string, string, string, WorkspaceProductApiLinkGetOptionalParams)
Pobiera link interfejsu API dla produktu.
function get(resourceGroupName: string, serviceName: string, workspaceId: string, productId: string, apiLinkId: string, options?: WorkspaceProductApiLinkGetOptionalParams): Promise<WorkspaceProductApiLinkGetResponse>
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.
- apiLinkId
-
string
Product-API identyfikator łącza. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
Parametry opcji.
Zwraca
Promise<WorkspaceProductApiLinkGetResponse>
listByProduct(string, string, string, string, WorkspaceProductApiLinkListByProductOptionalParams)
Wyświetla listę kolekcji łączy interfejsu API skojarzonych z produktem.
function listByProduct(resourceGroupName: string, serviceName: string, workspaceId: string, productId: string, options?: WorkspaceProductApiLinkListByProductOptionalParams): PagedAsyncIterableIterator<ProductApiLinkContract, ProductApiLinkContract[], 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.
- productId
-
string
Identyfikator produktu. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
Parametry opcji.