ProductApi interface
Interfejs reprezentujący element ProductApi.
Metody
| check |
Sprawdza, czy jednostka interfejsu API określona przez identyfikator jest skojarzona z jednostką Product. |
| create |
Dodaje interfejs API do określonego produktu. |
| delete(string, string, string, string, Product |
Usuwa określony interfejs API z określonego produktu. |
| list |
Wyświetla listę kolekcji interfejsów API skojarzonych z produktem. |
Szczegóły metody
checkEntityExists(string, string, string, string, ProductApiCheckEntityExistsOptionalParams)
Sprawdza, czy jednostka interfejsu API określona przez identyfikator jest skojarzona z jednostką Product.
function checkEntityExists(resourceGroupName: string, serviceName: string, productId: string, apiId: string, options?: ProductApiCheckEntityExistsOptionalParams): Promise<ProductApiCheckEntityExistsResponse>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. W nazwie jest uwzględniana 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.
- apiId
-
string
Identyfikator poprawki interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nieobsługiwana poprawka ma wartość ;rev=n jako sufiks, gdzie n jest numerem poprawki.
Parametry opcji.
Zwraca
Promise<ProductApiCheckEntityExistsResponse>
createOrUpdate(string, string, string, string, ProductApiCreateOrUpdateOptionalParams)
Dodaje interfejs API do określonego produktu.
function createOrUpdate(resourceGroupName: string, serviceName: string, productId: string, apiId: string, options?: ProductApiCreateOrUpdateOptionalParams): Promise<ApiContract>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. W nazwie jest uwzględniana 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.
- apiId
-
string
Identyfikator poprawki interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nieobsługiwana poprawka ma wartość ;rev=n jako sufiks, gdzie n jest numerem poprawki.
Parametry opcji.
Zwraca
Promise<ApiContract>
delete(string, string, string, string, ProductApiDeleteOptionalParams)
Usuwa określony interfejs API z określonego produktu.
function delete(resourceGroupName: string, serviceName: string, productId: string, apiId: string, options?: ProductApiDeleteOptionalParams): Promise<void>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. W nazwie jest uwzględniana 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.
- apiId
-
string
Identyfikator poprawki interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nieobsługiwana poprawka ma wartość ;rev=n jako sufiks, gdzie n jest numerem poprawki.
- options
- ProductApiDeleteOptionalParams
Parametry opcji.
Zwraca
Promise<void>
listByProduct(string, string, string, ProductApiListByProductOptionalParams)
Wyświetla listę kolekcji interfejsów API skojarzonych z produktem.
function listByProduct(resourceGroupName: string, serviceName: string, productId: string, options?: ProductApiListByProductOptionalParams): PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. W nazwie jest uwzględniana 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.
Parametry opcji.