Sdílet prostřednictvím

GatewayApi interface

  • Reference
Balíček:
@azure/arm-apimanagement

Rozhraní představující GatewayApi

Metody

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

Přidá rozhraní API do zadané brány.
delete(string, string, string, string, GatewayApiDeleteOptionalParams)

Odstraní zadané rozhraní API ze zadané brány.
getEntityTag(string, string, string, string, GatewayApiGetEntityTagOptionalParams)

Kontroluje, že entita rozhraní API zadaná identifikátorem je přidružená k entitě brány.
listByService(string, string, string, GatewayApiListByServiceOptionalParams)

Zobrazí kolekci rozhraní API přidružených k bráně.

Podrobnosti metody

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

Přidá rozhraní API do zadané brány.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

serviceName

string

Název služby API Management.

gatewayId

string

Identifikátor entity brány. V aktuální instanci služby API Management musí být jedinečné. Nesmí mít hodnotu managed.

apiId

string

Identifikátor rozhraní API. V aktuální instanci služby API Management musí být jedinečné.

options
GatewayApiCreateOrUpdateOptionalParams

Parametry možností.

Návraty

Promise<ApiContract>

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

Odstraní zadané rozhraní API ze zadané brány.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

serviceName

string

Název služby API Management.

gatewayId

string

Identifikátor entity brány. V aktuální instanci služby API Management musí být jedinečné. Nesmí mít hodnotu managed.

apiId

string

Identifikátor rozhraní API. V aktuální instanci služby API Management musí být jedinečné.

options
GatewayApiDeleteOptionalParams

Parametry možností.

Návraty

Promise<void>

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

Kontroluje, že entita rozhraní API zadaná identifikátorem je přidružená k entitě brány.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

serviceName

string

Název služby API Management.

gatewayId

string

Identifikátor entity brány. V aktuální instanci služby API Management musí být jedinečné. Nesmí mít hodnotu managed.

apiId

string

Identifikátor rozhraní API. V aktuální instanci služby API Management musí být jedinečné.

options
GatewayApiGetEntityTagOptionalParams

Parametry možností.

Návraty

Promise<GatewayApiGetEntityTagHeaders>

listByService(string, string, string, GatewayApiListByServiceOptionalParams)

Zobrazí kolekci rozhraní API přidružených k bráně.

function listByService(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayApiListByServiceOptionalParams): PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

serviceName

string

Název služby API Management.

gatewayId

string

Identifikátor entity brány. V aktuální instanci služby API Management musí být jedinečné. Nesmí mít hodnotu managed.

options
GatewayApiListByServiceOptionalParams

Parametry možností.

Návraty

PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>