Gateway interface
Rozhraní představující bránu
Metody
Podrobnosti metody
createOrUpdate(string, string, string, GatewayContract, GatewayCreateOrUpdateOptionalParams)
Vytvoří nebo aktualizuje bránu, která se má použít v instanci služby Api Management.
function createOrUpdate(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayContract, options?: GatewayCreateOrUpdateOptionalParams): Promise<GatewayCreateOrUpdateResponse>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.
- parameters
- GatewayContract
Podrobnosti o bráně
Parametry možností.
Návraty
Promise<GatewayCreateOrUpdateResponse>
delete(string, string, string, string, GatewayDeleteOptionalParams)
Odstraní konkrétní bránu.
function delete(resourceGroupName: string, serviceName: string, gatewayId: string, ifMatch: string, options?: GatewayDeleteOptionalParams): 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.
- ifMatch
-
string
ETag of the Entity. Značka ETag by měla odpovídat aktuálnímu stavu entity z odpovědi hlavičky požadavku GET, nebo by měla být * pro nepodmíněnou aktualizaci.
- options
- GatewayDeleteOptionalParams
Parametry možností.
Návraty
Promise<void>
generateToken(string, string, string, GatewayTokenRequestContract, GatewayGenerateTokenOptionalParams)
Získá sdílený přístupový autorizační token pro bránu.
function generateToken(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayTokenRequestContract, options?: GatewayGenerateTokenOptionalParams): Promise<GatewayTokenContract>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.
- parameters
- GatewayTokenRequestContract
Vlastnosti kontraktu žádosti o token brány
Parametry možností.
Návraty
Promise<GatewayTokenContract>
get(string, string, string, GatewayGetOptionalParams)
Získá podrobnosti brány určené jeho identifikátorem.
function get(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayGetOptionalParams): Promise<GatewayGetResponse>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
- GatewayGetOptionalParams
Parametry možností.
Návraty
Promise<GatewayGetResponse>
getEntityTag(string, string, string, GatewayGetEntityTagOptionalParams)
Získá verzi stavu entity (Etag) brány určené jeho identifikátorem.
function getEntityTag(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayGetEntityTagOptionalParams): Promise<GatewayGetEntityTagHeaders>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.
Parametry možností.
Návraty
Promise<GatewayGetEntityTagHeaders>
listByService(string, string, GatewayListByServiceOptionalParams)
Zobrazí kolekci bran zaregistrovaných v instanci služby.
function listByService(resourceGroupName: string, serviceName: string, options?: GatewayListByServiceOptionalParams): PagedAsyncIterableIterator<GatewayContract, GatewayContract[], 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.
Parametry možností.
Návraty
listKeys(string, string, string, GatewayListKeysOptionalParams)
Načte klíče brány.
function listKeys(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayListKeysOptionalParams): Promise<GatewayListKeysResponse>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
- GatewayListKeysOptionalParams
Parametry možností.
Návraty
Promise<GatewayListKeysResponse>
regenerateKey(string, string, string, GatewayKeyRegenerationRequestContract, GatewayRegenerateKeyOptionalParams)
Znovu vygeneruje zadaný klíč brány, který zneplatňuje všechny tokeny vytvořené s ním.
function regenerateKey(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayKeyRegenerationRequestContract, options?: GatewayRegenerateKeyOptionalParams): 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.
- parameters
- GatewayKeyRegenerationRequestContract
Vlastnosti kontraktu smlouvy o regeneraci klíčů brány
Parametry možností.
Návraty
Promise<void>
update(string, string, string, string, GatewayContract, GatewayUpdateOptionalParams)
Aktualizuje podrobnosti brány určené jeho identifikátorem.
function update(resourceGroupName: string, serviceName: string, gatewayId: string, ifMatch: string, parameters: GatewayContract, options?: GatewayUpdateOptionalParams): Promise<GatewayUpdateResponse>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.
- ifMatch
-
string
ETag of the Entity. Značka ETag by měla odpovídat aktuálnímu stavu entity z odpovědi hlavičky požadavku GET, nebo by měla být * pro nepodmíněnou aktualizaci.
- parameters
- GatewayContract
Podrobnosti o bráně
- options
- GatewayUpdateOptionalParams
Parametry možností.
Návraty
Promise<GatewayUpdateResponse>