Gateway interface
Interface die een gateway vertegenwoordigt.
Methoden
| create |
Hiermee maakt of werkt u een gateway bij die moet worden gebruikt in het Api Management-exemplaar. |
| delete(string, string, string, string, Gateway |
Hiermee verwijdert u specifieke gateway. |
| generate |
Hiermee haalt u het autorisatietoken voor gedeelde toegang voor de gateway op. |
| get(string, string, string, Gateway |
Hiermee haalt u de details op van de gateway die is opgegeven met de id. |
| get |
Hiermee wordt de versie van de entiteitsstatus (Etag) van de gateway opgehaald die is opgegeven door de id. |
| list |
Een lijst met een verzameling gateways die zijn geregistreerd bij het service-exemplaar. |
| list |
Hiermee worden gatewaysleutels opgehaald. |
| regenerate |
Genereert de opgegeven gatewaysleutel opnieuw die alle tokens ongeldig maakt die ermee zijn gemaakt. |
| update(string, string, string, string, Gateway |
Hiermee worden de details bijgewerkt van de gateway die is opgegeven met de id. |
Methodedetails
createOrUpdate(string, string, string, GatewayContract, GatewayCreateOrUpdateOptionalParams)
Hiermee maakt of werkt u een gateway bij die moet worden gebruikt in het Api Management-exemplaar.
function createOrUpdate(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayContract, options?: GatewayCreateOrUpdateOptionalParams): Promise<GatewayCreateOrUpdateResponse>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management-service.
- gatewayId
-
string
Gateway-entiteits-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service. Mag geen waarde 'beheerd' hebben
- parameters
- GatewayContract
Gatewaygegevens.
De optiesparameters.
Retouren
Promise<GatewayCreateOrUpdateResponse>
delete(string, string, string, string, GatewayDeleteOptionalParams)
Hiermee verwijdert u specifieke gateway.
function delete(resourceGroupName: string, serviceName: string, gatewayId: string, ifMatch: string, options?: GatewayDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management-service.
- gatewayId
-
string
Gateway-entiteits-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service. Mag geen waarde 'beheerd' hebben
- ifMatch
-
string
ETag van de entiteit. ETag moet overeenkomen met de huidige entiteitsstatus van het headerantwoord van de GET-aanvraag of moet * zijn voor een onvoorwaardelijke update.
- options
- GatewayDeleteOptionalParams
De optiesparameters.
Retouren
Promise<void>
generateToken(string, string, string, GatewayTokenRequestContract, GatewayGenerateTokenOptionalParams)
Hiermee haalt u het autorisatietoken voor gedeelde toegang voor de gateway op.
function generateToken(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayTokenRequestContract, options?: GatewayGenerateTokenOptionalParams): Promise<GatewayTokenContract>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management-service.
- gatewayId
-
string
Gateway-entiteits-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service. Mag geen waarde 'beheerd' hebben
- parameters
- GatewayTokenRequestContract
Gatewaytoken vraagt contracteigenschappen aan.
De optiesparameters.
Retouren
Promise<GatewayTokenContract>
get(string, string, string, GatewayGetOptionalParams)
Hiermee haalt u de details op van de gateway die is opgegeven met de id.
function get(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayGetOptionalParams): Promise<GatewayGetResponse>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management-service.
- gatewayId
-
string
Gateway-entiteits-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service. Mag geen waarde 'beheerd' hebben
- options
- GatewayGetOptionalParams
De optiesparameters.
Retouren
Promise<GatewayGetResponse>
getEntityTag(string, string, string, GatewayGetEntityTagOptionalParams)
Hiermee wordt de versie van de entiteitsstatus (Etag) van de gateway opgehaald die is opgegeven door de id.
function getEntityTag(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayGetEntityTagOptionalParams): Promise<GatewayGetEntityTagHeaders>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management-service.
- gatewayId
-
string
Gateway-entiteits-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service. Mag geen waarde 'beheerd' hebben
De optiesparameters.
Retouren
Promise<GatewayGetEntityTagHeaders>
listByService(string, string, GatewayListByServiceOptionalParams)
Een lijst met een verzameling gateways die zijn geregistreerd bij het service-exemplaar.
function listByService(resourceGroupName: string, serviceName: string, options?: GatewayListByServiceOptionalParams): PagedAsyncIterableIterator<GatewayContract, GatewayContract[], PageSettings>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management-service.
De optiesparameters.
Retouren
listKeys(string, string, string, GatewayListKeysOptionalParams)
Hiermee worden gatewaysleutels opgehaald.
function listKeys(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayListKeysOptionalParams): Promise<GatewayListKeysResponse>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management-service.
- gatewayId
-
string
Gateway-entiteits-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service. Mag geen waarde 'beheerd' hebben
- options
- GatewayListKeysOptionalParams
De optiesparameters.
Retouren
Promise<GatewayListKeysResponse>
regenerateKey(string, string, string, GatewayKeyRegenerationRequestContract, GatewayRegenerateKeyOptionalParams)
Genereert de opgegeven gatewaysleutel opnieuw die alle tokens ongeldig maakt die ermee zijn gemaakt.
function regenerateKey(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayKeyRegenerationRequestContract, options?: GatewayRegenerateKeyOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management-service.
- gatewayId
-
string
Gateway-entiteits-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service. Mag geen waarde 'beheerd' hebben
- parameters
- GatewayKeyRegenerationRequestContract
Contracteigenschappen voor het opnieuw genereren van gatewaysleutels.
De optiesparameters.
Retouren
Promise<void>
update(string, string, string, string, GatewayContract, GatewayUpdateOptionalParams)
Hiermee worden de details bijgewerkt van de gateway die is opgegeven met de id.
function update(resourceGroupName: string, serviceName: string, gatewayId: string, ifMatch: string, parameters: GatewayContract, options?: GatewayUpdateOptionalParams): Promise<GatewayUpdateResponse>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management-service.
- gatewayId
-
string
Gateway-entiteits-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service. Mag geen waarde 'beheerd' hebben
- ifMatch
-
string
ETag van de entiteit. ETag moet overeenkomen met de huidige entiteitsstatus van het headerantwoord van de GET-aanvraag of moet * zijn voor een onvoorwaardelijke update.
- parameters
- GatewayContract
Gatewaygegevens.
- options
- GatewayUpdateOptionalParams
De optiesparameters.
Retouren
Promise<GatewayUpdateResponse>