Gateway interface
Schnittstelle, die ein Gateway darstellt.
Methoden
Details zur Methode
createOrUpdate(string, string, string, GatewayContract, GatewayCreateOrUpdateOptionalParams)
Erstellt oder aktualisiert ein Gateway, das in Api Management instance verwendet werden soll.
function createOrUpdate(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayContract, options?: GatewayCreateOrUpdateOptionalParams): Promise<GatewayCreateOrUpdateResponse>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API Management-Diensts.
- gatewayId
-
string
Gatewayentitätsbezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein. Darf nicht über den Wert "managed" verfügen.
- parameters
- GatewayContract
Gatewaydetails.
Die Optionsparameter.
Gibt zurück
Promise<GatewayCreateOrUpdateResponse>
delete(string, string, string, string, GatewayDeleteOptionalParams)
Löscht das angegebene Gateway.
function delete(resourceGroupName: string, serviceName: string, gatewayId: string, ifMatch: string, options?: GatewayDeleteOptionalParams): Promise<void>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API Management-Diensts.
- gatewayId
-
string
Gatewayentitätsbezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein. Darf nicht über den Wert "managed" verfügen.
- ifMatch
-
string
ETag der Entität. ETag sollte mit dem aktuellen Entitätsstatus aus der Headerantwort der GET-Anforderung übereinstimmen, oder es sollte * für die bedingungslose Aktualisierung sein.
- options
- GatewayDeleteOptionalParams
Die Optionsparameter.
Gibt zurück
Promise<void>
generateToken(string, string, string, GatewayTokenRequestContract, GatewayGenerateTokenOptionalParams)
Ruft das SAS-Autorisierungstoken für das Gateway ab.
function generateToken(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayTokenRequestContract, options?: GatewayGenerateTokenOptionalParams): Promise<GatewayTokenContract>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API Management-Diensts.
- gatewayId
-
string
Gatewayentitätsbezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein. Darf nicht über den Wert "managed" verfügen.
- parameters
- GatewayTokenRequestContract
Eigenschaften des Gatewaytokenanforderungsvertrags.
Die Optionsparameter.
Gibt zurück
Promise<GatewayTokenContract>
get(string, string, string, GatewayGetOptionalParams)
Ruft die Details des Gateways ab, das durch seinen Bezeichner angegeben wird.
function get(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayGetOptionalParams): Promise<GatewayGetResponse>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API Management-Diensts.
- gatewayId
-
string
Gatewayentitätsbezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein. Darf nicht über den Wert "managed" verfügen.
- options
- GatewayGetOptionalParams
Die Optionsparameter.
Gibt zurück
Promise<GatewayGetResponse>
getEntityTag(string, string, string, GatewayGetEntityTagOptionalParams)
Ruft die Etag-Version (Entity State) des Gateways ab, das durch seinen Bezeichner angegeben wird.
function getEntityTag(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayGetEntityTagOptionalParams): Promise<GatewayGetEntityTagHeaders>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API Management-Diensts.
- gatewayId
-
string
Gatewayentitätsbezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein. Darf nicht über den Wert "managed" verfügen.
Die Optionsparameter.
Gibt zurück
Promise<GatewayGetEntityTagHeaders>
listByService(string, string, GatewayListByServiceOptionalParams)
Listet eine Auflistung von Gateways auf, die bei der Dienstinstanz registriert sind,
function listByService(resourceGroupName: string, serviceName: string, options?: GatewayListByServiceOptionalParams): PagedAsyncIterableIterator<GatewayContract, GatewayContract[], PageSettings>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API Management-Diensts.
Die Optionsparameter.
Gibt zurück
listKeys(string, string, string, GatewayListKeysOptionalParams)
Ruft Gatewayschlüssel ab.
function listKeys(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayListKeysOptionalParams): Promise<GatewayListKeysResponse>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API Management-Diensts.
- gatewayId
-
string
Gatewayentitätsbezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein. Darf nicht über den Wert "managed" verfügen.
- options
- GatewayListKeysOptionalParams
Die Optionsparameter.
Gibt zurück
Promise<GatewayListKeysResponse>
regenerateKey(string, string, string, GatewayKeyRegenerationRequestContract, GatewayRegenerateKeyOptionalParams)
Generiert den angegebenen Gatewayschlüssel neu, wobei alle damit erstellten Token ungültig werden.
function regenerateKey(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayKeyRegenerationRequestContract, options?: GatewayRegenerateKeyOptionalParams): Promise<void>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API Management-Diensts.
- gatewayId
-
string
Gatewayentitätsbezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein. Darf nicht über den Wert "managed" verfügen.
- parameters
- GatewayKeyRegenerationRequestContract
Eigenschaften des Vertrags für die Gatewayschlüsselregeneration.
Die Optionsparameter.
Gibt zurück
Promise<void>
update(string, string, string, string, GatewayContract, GatewayUpdateOptionalParams)
Updates die Details des gateways, das durch seinen Bezeichner angegeben wird.
function update(resourceGroupName: string, serviceName: string, gatewayId: string, ifMatch: string, parameters: GatewayContract, options?: GatewayUpdateOptionalParams): Promise<GatewayUpdateResponse>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API Management-Diensts.
- gatewayId
-
string
Gatewayentitätsbezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein. Darf nicht über den Wert "managed" verfügen.
- ifMatch
-
string
ETag der Entität. ETag sollte mit dem aktuellen Entitätsstatus aus der Headerantwort der GET-Anforderung übereinstimmen, oder es sollte * für die bedingungslose Aktualisierung sein.
- parameters
- GatewayContract
Gatewaydetails.
- options
- GatewayUpdateOptionalParams
Die Optionsparameter.
Gibt zurück
Promise<GatewayUpdateResponse>