GatewayApi interface
Schnittstelle, die ein GatewayApi darstellt.
Methoden
| create |
Fügt dem angegebenen Gateway eine API hinzu. |
| delete(string, string, string, string, Gateway |
Löscht die angegebene API aus dem angegebenen Gateway. |
| get |
Überprüft, ob die durch den Bezeichner angegebene API-Entität der Gatewayentität zugeordnet ist. |
| list |
Listet eine Sammlung mit den APIs auf, die einem Gateway zugeordnet sind. |
Details zur Methode
createOrUpdate(string, string, string, string, GatewayApiCreateOrUpdateOptionalParams)
Fügt dem angegebenen Gateway eine API hinzu.
function createOrUpdate(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiCreateOrUpdateOptionalParams): Promise<ApiContract>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 "verwaltet" verfügen
- apiId
-
string
API-Bezeichner. Muss im aktuellen API Management Dienst instance eindeutig sein.
Die Optionsparameter.
Gibt zurück
Promise<ApiContract>
delete(string, string, string, string, GatewayApiDeleteOptionalParams)
Löscht die angegebene API aus dem angegebenen Gateway.
function delete(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiDeleteOptionalParams): 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 "verwaltet" verfügen
- apiId
-
string
API-Bezeichner. Muss im aktuellen API Management Dienst instance eindeutig sein.
- options
- GatewayApiDeleteOptionalParams
Die Optionsparameter.
Gibt zurück
Promise<void>
getEntityTag(string, string, string, string, GatewayApiGetEntityTagOptionalParams)
Überprüft, ob die durch den Bezeichner angegebene API-Entität der Gatewayentität zugeordnet ist.
function getEntityTag(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiGetEntityTagOptionalParams): Promise<GatewayApiGetEntityTagHeaders>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 "verwaltet" verfügen
- apiId
-
string
API-Bezeichner. Muss im aktuellen API Management Dienst instance eindeutig sein.
Die Optionsparameter.
Gibt zurück
Promise<GatewayApiGetEntityTagHeaders>
listByService(string, string, string, GatewayApiListByServiceOptionalParams)
Listet eine Sammlung mit den APIs auf, die einem Gateway zugeordnet sind.
function listByService(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayApiListByServiceOptionalParams): PagedAsyncIterableIterator<ApiContract, ApiContract[], 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 "verwaltet" verfügen
Die Optionsparameter.