Gateway interface

Paket:

@azure/arm-apimanagement

Gränssnitt som representerar en gateway.

Metoder

createOrUpdate(string, string, string, GatewayContract, GatewayCreateOrUpdateOptionalParams)	Skapar eller uppdaterar en gateway som ska användas i Api Management-instansen.
delete(string, string, string, string, GatewayDeleteOptionalParams)	Tar bort specifik gateway.
generateToken(string, string, string, GatewayTokenRequestContract, GatewayGenerateTokenOptionalParams)	Hämtar token för auktorisering för delad åtkomst för gatewayen.
get(string, string, string, GatewayGetOptionalParams)	Hämtar information om gatewayen som anges av dess identifierare.
getEntityTag(string, string, string, GatewayGetEntityTagOptionalParams)	Hämtar entitetstillståndsversionen (Etag) av gatewayen som anges av dess identifierare.
listByService(string, string, GatewayListByServiceOptionalParams)	Visar en samling gatewayer som är registrerade med tjänstinstansen.
listKeys(string, string, string, GatewayListKeysOptionalParams)	Hämtar gatewaynycklar.
regenerateKey(string, string, string, GatewayKeyRegenerationRequestContract, GatewayRegenerateKeyOptionalParams)	Återskapar den angivna gatewaynyckeln som ogiltigförklarar eventuella token som skapats med den.
update(string, string, string, string, GatewayContract, GatewayUpdateOptionalParams)	Uppdateringar information om gatewayen som anges av dess identifierare.

Metodinformation

createOrUpdate(string, string, string, GatewayContract, GatewayCreateOrUpdateOptionalParams)

Skapar eller uppdaterar en gateway som ska användas i Api Management-instansen.

function createOrUpdate(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayContract, options?: GatewayCreateOrUpdateOptionalParams): Promise<GatewayCreateOrUpdateResponse>

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

gatewayId

string

Gatewayentitetsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen. Får inte ha värdet "hanterat"

parameters

GatewayContract

Gatewayinformation.

options

GatewayCreateOrUpdateOptionalParams

Alternativparametrarna.

Returer

Promise<GatewayCreateOrUpdateResponse>

delete(string, string, string, string, GatewayDeleteOptionalParams)

Tar bort specifik gateway.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

gatewayId

string

Gatewayentitetsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen. Får inte ha värdet "hanterat"

ifMatch

string

ETag för entiteten. ETag ska matcha det aktuella entitetstillståndet från huvudsvaret för GET-begäran eller * för ovillkorlig uppdatering.

options

GatewayDeleteOptionalParams

Alternativparametrarna.

Returer

Promise<void>

generateToken(string, string, string, GatewayTokenRequestContract, GatewayGenerateTokenOptionalParams)

Hämtar token för auktorisering för delad åtkomst för gatewayen.

function generateToken(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayTokenRequestContract, options?: GatewayGenerateTokenOptionalParams): Promise<GatewayTokenContract>

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

gatewayId

string

Gatewayentitetsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen. Får inte ha värdet "hanterat"

parameters

GatewayTokenRequestContract

Egenskaper för gatewaytokenbegärandekontrakt.

options

GatewayGenerateTokenOptionalParams

Alternativparametrarna.

Returer

Promise<GatewayTokenContract>

get(string, string, string, GatewayGetOptionalParams)

Hämtar information om gatewayen som anges av dess identifierare.

function get(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayGetOptionalParams): Promise<GatewayGetResponse>

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

gatewayId

string

Gatewayentitetsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen. Får inte ha värdet "hanterat"

options

GatewayGetOptionalParams

Alternativparametrarna.

Returer

Promise<GatewayGetResponse>

getEntityTag(string, string, string, GatewayGetEntityTagOptionalParams)

Hämtar entitetstillståndsversionen (Etag) av gatewayen som anges av dess identifierare.

function getEntityTag(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayGetEntityTagOptionalParams): Promise<GatewayGetEntityTagHeaders>

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

gatewayId

string

Gatewayentitetsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen. Får inte ha värdet "hanterat"

options

GatewayGetEntityTagOptionalParams

Alternativparametrarna.

Returer

Promise<GatewayGetEntityTagHeaders>

listByService(string, string, GatewayListByServiceOptionalParams)

Visar en samling gatewayer som är registrerade med tjänstinstansen.

function listByService(resourceGroupName: string, serviceName: string, options?: GatewayListByServiceOptionalParams): PagedAsyncIterableIterator<GatewayContract, GatewayContract[], PageSettings>

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

options

GatewayListByServiceOptionalParams

Alternativparametrarna.

Returer

PagedAsyncIterableIterator<GatewayContract, GatewayContract[], PageSettings>

listKeys(string, string, string, GatewayListKeysOptionalParams)

Hämtar gatewaynycklar.

function listKeys(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayListKeysOptionalParams): Promise<GatewayListKeysResponse>

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

gatewayId

string

Gatewayentitetsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen. Får inte ha värdet "hanterat"

options

GatewayListKeysOptionalParams

Alternativparametrarna.

Returer

Promise<GatewayListKeysResponse>

regenerateKey(string, string, string, GatewayKeyRegenerationRequestContract, GatewayRegenerateKeyOptionalParams)

Återskapar den angivna gatewaynyckeln som ogiltigförklarar eventuella token som skapats med den.

function regenerateKey(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayKeyRegenerationRequestContract, options?: GatewayRegenerateKeyOptionalParams): Promise<void>

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

gatewayId

string

Gatewayentitetsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen. Får inte ha värdet "hanterat"

parameters

GatewayKeyRegenerationRequestContract

Egenskaper för begäran om kontrakt för gatewaynyckelförnyelse.

options

GatewayRegenerateKeyOptionalParams

Alternativparametrarna.

Returer

Promise<void>

update(string, string, string, string, GatewayContract, GatewayUpdateOptionalParams)

Uppdateringar information om gatewayen som anges av dess identifierare.

function update(resourceGroupName: string, serviceName: string, gatewayId: string, ifMatch: string, parameters: GatewayContract, options?: GatewayUpdateOptionalParams): Promise<GatewayUpdateResponse>

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

gatewayId

string

Gatewayentitetsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen. Får inte ha värdet "hanterat"

ifMatch

string

ETag för entiteten. ETag ska matcha det aktuella entitetstillståndet från huvudsvaret för GET-begäran eller * för ovillkorlig uppdatering.

parameters

GatewayContract

Gatewayinformation.

options

GatewayUpdateOptionalParams

Alternativparametrarna.

Returer

Promise<GatewayUpdateResponse>