GatewayHostnameConfiguration interface
Schnittstelle, die eine GatewayHostnameConfiguration darstellt.
Methoden
create |
Erstellt die Hostnamenkonfiguration für updates für ein Gateway. |
delete(string, string, string, string, string, Gateway |
Löscht die angegebene Hostnamenkonfiguration aus dem angegebenen Gateway. |
get(string, string, string, string, Gateway |
Abrufen von Details zu einer Hostnamenkonfiguration |
get |
Überprüft, ob die durch den Bezeichner angegebene Hostnamenkonfigurationsentität für die angegebene Gatewayentität vorhanden ist. |
list |
Listet die Sammlung mit den Hostnamenkonfigurationen für das angegebene Gateway auf. |
Details zur Methode
createOrUpdate(string, string, string, string, GatewayHostnameConfigurationContract, GatewayHostnameConfigurationCreateOrUpdateOptionalParams)
Erstellt die Hostnamenkonfiguration für updates für ein Gateway.
function createOrUpdate(resourceGroupName: string, serviceName: string, gatewayId: string, hcId: string, parameters: GatewayHostnameConfigurationContract, options?: GatewayHostnameConfigurationCreateOrUpdateOptionalParams): Promise<GatewayHostnameConfigurationCreateOrUpdateResponse>
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.
- hcId
-
string
Konfigurationsbezeichner des Gatewayhostnamens. Muss im Bereich der übergeordneten Gatewayentität eindeutig sein.
- parameters
- GatewayHostnameConfigurationContract
Details zur Konfiguration des Gatewayhostnamens.
Die Optionsparameter.
Gibt zurück
delete(string, string, string, string, string, GatewayHostnameConfigurationDeleteOptionalParams)
Löscht die angegebene Hostnamenkonfiguration aus dem angegebenen Gateway.
function delete(resourceGroupName: string, serviceName: string, gatewayId: string, hcId: string, ifMatch: string, options?: GatewayHostnameConfigurationDeleteOptionalParams): 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.
- hcId
-
string
Konfigurationsbezeichner des Gatewayhostnamens. Muss im Bereich der übergeordneten Gatewayentität eindeutig sein.
- 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.
Die Optionsparameter.
Gibt zurück
Promise<void>
get(string, string, string, string, GatewayHostnameConfigurationGetOptionalParams)
Abrufen von Details zu einer Hostnamenkonfiguration
function get(resourceGroupName: string, serviceName: string, gatewayId: string, hcId: string, options?: GatewayHostnameConfigurationGetOptionalParams): Promise<GatewayHostnameConfigurationGetResponse>
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.
- hcId
-
string
Konfigurationsbezeichner des Gatewayhostnamens. Muss im Bereich der übergeordneten Gatewayentität eindeutig sein.
Die Optionsparameter.
Gibt zurück
getEntityTag(string, string, string, string, GatewayHostnameConfigurationGetEntityTagOptionalParams)
Überprüft, ob die durch den Bezeichner angegebene Hostnamenkonfigurationsentität für die angegebene Gatewayentität vorhanden ist.
function getEntityTag(resourceGroupName: string, serviceName: string, gatewayId: string, hcId: string, options?: GatewayHostnameConfigurationGetEntityTagOptionalParams): Promise<GatewayHostnameConfigurationGetEntityTagHeaders>
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.
- hcId
-
string
Konfigurationsbezeichner des Gatewayhostnamens. Muss im Bereich der übergeordneten Gatewayentität eindeutig sein.
Die Optionsparameter.
Gibt zurück
listByService(string, string, string, GatewayHostnameConfigurationListByServiceOptionalParams)
Listet die Sammlung mit den Hostnamenkonfigurationen für das angegebene Gateway auf.
function listByService(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayHostnameConfigurationListByServiceOptionalParams): PagedAsyncIterableIterator<GatewayHostnameConfigurationContract, GatewayHostnameConfigurationContract[], 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.
- gatewayId
-
string
Gatewayentitätsbezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein. Darf nicht über den Wert "managed" verfügen.
Die Optionsparameter.