Udostępnij za pośrednictwem

GatewayApi interface

  • Odwołanie
Pakiet:
@azure/arm-apimanagement

Interfejs reprezentujący interfejs GatewayApi.

Metody

createOrUpdate(string, string, string, string, GatewayApiCreateOrUpdateOptionalParams)

Dodaje interfejs API do określonej bramy.
delete(string, string, string, string, GatewayApiDeleteOptionalParams)

Usuwa określony interfejs API z określonej bramy.
getEntityTag(string, string, string, string, GatewayApiGetEntityTagOptionalParams)

Sprawdza, czy jednostka interfejsu API określona przez identyfikator jest skojarzona z jednostką bramy.
listByService(string, string, string, GatewayApiListByServiceOptionalParams)

Wyświetla listę kolekcji interfejsów API skojarzonych z bramą.

Szczegóły metody

createOrUpdate(string, string, string, string, GatewayApiCreateOrUpdateOptionalParams)

Dodaje interfejs API do określonej bramy.

function createOrUpdate(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiCreateOrUpdateOptionalParams): Promise<ApiContract>

Parametry

resourceGroupName

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

serviceName

string

Nazwa usługi API Management.

gatewayId

string

Identyfikator jednostki bramy. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nie może mieć wartości "zarządzanej"

apiId

string

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

options
GatewayApiCreateOrUpdateOptionalParams

Parametry opcji.

Zwraca

Promise<ApiContract>

delete(string, string, string, string, GatewayApiDeleteOptionalParams)

Usuwa określony interfejs API z określonej bramy.

function delete(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiDeleteOptionalParams): Promise<void>

Parametry

resourceGroupName

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

serviceName

string

Nazwa usługi API Management.

gatewayId

string

Identyfikator jednostki bramy. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nie może mieć wartości "zarządzanej"

apiId

string

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

options
GatewayApiDeleteOptionalParams

Parametry opcji.

Zwraca

Promise<void>

getEntityTag(string, string, string, string, GatewayApiGetEntityTagOptionalParams)

Sprawdza, czy jednostka interfejsu API określona przez identyfikator jest skojarzona z jednostką bramy.

function getEntityTag(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiGetEntityTagOptionalParams): Promise<GatewayApiGetEntityTagHeaders>

Parametry

resourceGroupName

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

serviceName

string

Nazwa usługi API Management.

gatewayId

string

Identyfikator jednostki bramy. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nie może mieć wartości "zarządzanej"

apiId

string

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

options
GatewayApiGetEntityTagOptionalParams

Parametry opcji.

Zwraca

Promise<GatewayApiGetEntityTagHeaders>

listByService(string, string, string, GatewayApiListByServiceOptionalParams)

Wyświetla listę kolekcji interfejsów API skojarzonych z bramą.

function listByService(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayApiListByServiceOptionalParams): 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.

gatewayId

string

Identyfikator jednostki bramy. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nie może mieć wartości "zarządzanej"

options
GatewayApiListByServiceOptionalParams

Parametry opcji.

Zwraca

PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>