GatewayApi interface
Interface die een GatewayApi vertegenwoordigt.
Methoden
| create |
Hiermee voegt u een API toe aan de opgegeven gateway. |
| delete(string, string, string, string, Gateway |
Hiermee verwijdert u de opgegeven API uit de opgegeven gateway. |
| get |
Controleert of de API-entiteit die is opgegeven door id, is gekoppeld aan de gateway-entiteit. |
| list |
Een lijst met een verzameling API's die zijn gekoppeld aan een gateway. |
Methodedetails
createOrUpdate(string, string, string, string, GatewayApiCreateOrUpdateOptionalParams)
Hiermee voegt u een API toe aan de opgegeven gateway.
function createOrUpdate(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiCreateOrUpdateOptionalParams): Promise<ApiContract>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 API Management service-exemplaar. Mag geen waarde 'beheerd' hebben
- apiId
-
string
API-id. Moet uniek zijn in het huidige API Management service-exemplaar.
De optiesparameters.
Retouren
Promise<ApiContract>
delete(string, string, string, string, GatewayApiDeleteOptionalParams)
Hiermee verwijdert u de opgegeven API uit de opgegeven gateway.
function delete(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiDeleteOptionalParams): 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 API Management service-exemplaar. Mag geen waarde 'beheerd' hebben
- apiId
-
string
API-id. Moet uniek zijn in het huidige API Management service-exemplaar.
- options
- GatewayApiDeleteOptionalParams
De optiesparameters.
Retouren
Promise<void>
getEntityTag(string, string, string, string, GatewayApiGetEntityTagOptionalParams)
Controleert of de API-entiteit die is opgegeven door id, is gekoppeld aan de gateway-entiteit.
function getEntityTag(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiGetEntityTagOptionalParams): Promise<GatewayApiGetEntityTagHeaders>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 API Management service-exemplaar. Mag geen waarde 'beheerd' hebben
- apiId
-
string
API-id. Moet uniek zijn in het huidige API Management service-exemplaar.
De optiesparameters.
Retouren
Promise<GatewayApiGetEntityTagHeaders>
listByService(string, string, string, GatewayApiListByServiceOptionalParams)
Een lijst met een verzameling API's die zijn gekoppeld aan een gateway.
function listByService(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayApiListByServiceOptionalParams): PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>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 API Management service-exemplaar. Mag geen waarde 'beheerd' hebben
De optiesparameters.