Backend interface
Interface die een back-end vertegenwoordigt.
Methoden
| create |
Hiermee maakt of werkt u een back-end bij. |
| delete(string, string, string, string, Backend |
Hiermee verwijdert u de opgegeven back-end. |
| get(string, string, string, Backend |
Hiermee haalt u de details op van de back-end die is opgegeven door de id. |
| get |
Hiermee wordt de versie van de entiteitsstatus (Etag) van de back-end opgehaald die is opgegeven door de id. |
| list |
Geeft een verzameling back-ends weer in het opgegeven service-exemplaar. |
| reconnect(string, string, string, Backend |
Hiermee wordt de API Management-gateway op de hoogte gebracht voor het maken van een nieuwe verbinding met de back-end na de opgegeven time-out. Als er geen time-out is opgegeven, wordt er een time-out van 2 minuten gebruikt. |
| update(string, string, string, string, Backend |
Hiermee werkt u een bestaande back-end bij. |
Methodedetails
createOrUpdate(string, string, string, BackendContract, BackendCreateOrUpdateOptionalParams)
Hiermee maakt of werkt u een back-end bij.
function createOrUpdate(resourceGroupName: string, serviceName: string, backendId: string, parameters: BackendContract, options?: BackendCreateOrUpdateOptionalParams): Promise<BackendCreateOrUpdateResponse>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management-service.
- backendId
-
string
Id van de back-endentiteit. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service.
- parameters
- BackendContract
Parameters maken.
De optiesparameters.
Retouren
Promise<BackendCreateOrUpdateResponse>
delete(string, string, string, string, BackendDeleteOptionalParams)
Hiermee verwijdert u de opgegeven back-end.
function delete(resourceGroupName: string, serviceName: string, backendId: string, ifMatch: string, options?: BackendDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management-service.
- backendId
-
string
Id van de back-endentiteit. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service.
- 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
- BackendDeleteOptionalParams
De optiesparameters.
Retouren
Promise<void>
get(string, string, string, BackendGetOptionalParams)
Hiermee haalt u de details op van de back-end die is opgegeven door de id.
function get(resourceGroupName: string, serviceName: string, backendId: string, options?: BackendGetOptionalParams): Promise<BackendGetResponse>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management-service.
- backendId
-
string
Id van de back-endentiteit. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service.
- options
- BackendGetOptionalParams
De optiesparameters.
Retouren
Promise<BackendGetResponse>
getEntityTag(string, string, string, BackendGetEntityTagOptionalParams)
Hiermee wordt de versie van de entiteitsstatus (Etag) van de back-end opgehaald die is opgegeven door de id.
function getEntityTag(resourceGroupName: string, serviceName: string, backendId: string, options?: BackendGetEntityTagOptionalParams): Promise<BackendGetEntityTagHeaders>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management-service.
- backendId
-
string
Id van de back-endentiteit. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service.
De optiesparameters.
Retouren
Promise<BackendGetEntityTagHeaders>
listByService(string, string, BackendListByServiceOptionalParams)
Geeft een verzameling back-ends weer in het opgegeven service-exemplaar.
function listByService(resourceGroupName: string, serviceName: string, options?: BackendListByServiceOptionalParams): PagedAsyncIterableIterator<BackendContract, BackendContract[], 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
reconnect(string, string, string, BackendReconnectOptionalParams)
Hiermee wordt de API Management-gateway op de hoogte gebracht voor het maken van een nieuwe verbinding met de back-end na de opgegeven time-out. Als er geen time-out is opgegeven, wordt er een time-out van 2 minuten gebruikt.
function reconnect(resourceGroupName: string, serviceName: string, backendId: string, options?: BackendReconnectOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management-service.
- backendId
-
string
Id van de back-endentiteit. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service.
- options
- BackendReconnectOptionalParams
De optiesparameters.
Retouren
Promise<void>
update(string, string, string, string, BackendUpdateParameters, BackendUpdateOptionalParams)
Hiermee werkt u een bestaande back-end bij.
function update(resourceGroupName: string, serviceName: string, backendId: string, ifMatch: string, parameters: BackendUpdateParameters, options?: BackendUpdateOptionalParams): Promise<BackendUpdateResponse>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management-service.
- backendId
-
string
Id van de back-endentiteit. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service.
- 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
- BackendUpdateParameters
Parameters bijwerken.
- options
- BackendUpdateOptionalParams
De optiesparameters.
Retouren
Promise<BackendUpdateResponse>