Backend interface
Háttérrendszert képviselő felület.
Metódusok
| create |
Létrehoz vagy frissít egy háttérrendszert. |
| delete(string, string, string, string, Backend |
Törli a megadott háttérrendszert. |
| get(string, string, string, Backend |
Lekéri az azonosító által megadott háttérrendszer adatait. |
| get |
Lekéri az azonosító által megadott háttérrendszer entitásállapotának (Etag) verzióját. |
| list |
A megadott szolgáltatáspéldány háttérrendszereinek gyűjteményét sorolja fel. |
| reconnect(string, string, string, Backend |
Értesíti az API Management-átjárót, hogy hozzon létre egy új kapcsolatot a háttérrendszerrel a megadott időtúllépés után. Ha nem adott meg időtúllépést, a rendszer 2 perces időtúllépést használ. |
| update(string, string, string, string, Backend |
Meglévő háttérrendszer frissítése. |
Metódus adatai
createOrUpdate(string, string, string, BackendContract, BackendCreateOrUpdateOptionalParams)
Létrehoz vagy frissít egy háttérrendszert.
function createOrUpdate(resourceGroupName: string, serviceName: string, backendId: string, parameters: BackendContract, options?: BackendCreateOrUpdateOptionalParams): Promise<BackendCreateOrUpdateResponse>
Paraméterek
- resourceGroupName
-
string
Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
- serviceName
-
string
Az API Management szolgáltatás neve.
- backendId
-
string
A Háttér entitás azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.
- parameters
- BackendContract
Paraméterek létrehozása.
A beállítások paraméterei.
Válaszok
Promise<BackendCreateOrUpdateResponse>
delete(string, string, string, string, BackendDeleteOptionalParams)
Törli a megadott háttérrendszert.
function delete(resourceGroupName: string, serviceName: string, backendId: string, ifMatch: string, options?: BackendDeleteOptionalParams): Promise<void>
Paraméterek
- resourceGroupName
-
string
Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
- serviceName
-
string
Az API Management szolgáltatás neve.
- backendId
-
string
A Háttér entitás azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.
- ifMatch
-
string
Az entitás ETagje. Az ETag-nek meg kell egyeznie a GET-kérés fejlécválaszából származó aktuális entitásállapotmal, vagy * kell lennie a feltétel nélküli frissítéshez.
- options
- BackendDeleteOptionalParams
A beállítások paraméterei.
Válaszok
Promise<void>
get(string, string, string, BackendGetOptionalParams)
Lekéri az azonosító által megadott háttérrendszer adatait.
function get(resourceGroupName: string, serviceName: string, backendId: string, options?: BackendGetOptionalParams): Promise<BackendGetResponse>
Paraméterek
- resourceGroupName
-
string
Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
- serviceName
-
string
Az API Management szolgáltatás neve.
- backendId
-
string
A Háttér entitás azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.
- options
- BackendGetOptionalParams
A beállítások paraméterei.
Válaszok
Promise<BackendGetResponse>
getEntityTag(string, string, string, BackendGetEntityTagOptionalParams)
Lekéri az azonosító által megadott háttérrendszer entitásállapotának (Etag) verzióját.
function getEntityTag(resourceGroupName: string, serviceName: string, backendId: string, options?: BackendGetEntityTagOptionalParams): Promise<BackendGetEntityTagHeaders>
Paraméterek
- resourceGroupName
-
string
Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
- serviceName
-
string
Az API Management szolgáltatás neve.
- backendId
-
string
A Háttér entitás azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.
A beállítások paraméterei.
Válaszok
Promise<BackendGetEntityTagHeaders>
listByService(string, string, BackendListByServiceOptionalParams)
A megadott szolgáltatáspéldány háttérrendszereinek gyűjteményét sorolja fel.
function listByService(resourceGroupName: string, serviceName: string, options?: BackendListByServiceOptionalParams): PagedAsyncIterableIterator<BackendContract, BackendContract[], PageSettings>
Paraméterek
- resourceGroupName
-
string
Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
- serviceName
-
string
Az API Management szolgáltatás neve.
A beállítások paraméterei.
Válaszok
reconnect(string, string, string, BackendReconnectOptionalParams)
Értesíti az API Management-átjárót, hogy hozzon létre egy új kapcsolatot a háttérrendszerrel a megadott időtúllépés után. Ha nem adott meg időtúllépést, a rendszer 2 perces időtúllépést használ.
function reconnect(resourceGroupName: string, serviceName: string, backendId: string, options?: BackendReconnectOptionalParams): Promise<void>
Paraméterek
- resourceGroupName
-
string
Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
- serviceName
-
string
Az API Management szolgáltatás neve.
- backendId
-
string
A Háttér entitás azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.
- options
- BackendReconnectOptionalParams
A beállítások paraméterei.
Válaszok
Promise<void>
update(string, string, string, string, BackendUpdateParameters, BackendUpdateOptionalParams)
Meglévő háttérrendszer frissítése.
function update(resourceGroupName: string, serviceName: string, backendId: string, ifMatch: string, parameters: BackendUpdateParameters, options?: BackendUpdateOptionalParams): Promise<BackendUpdateResponse>
Paraméterek
- resourceGroupName
-
string
Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
- serviceName
-
string
Az API Management szolgáltatás neve.
- backendId
-
string
A Háttér entitás azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.
- ifMatch
-
string
Az entitás ETagje. Az ETag-nek meg kell egyeznie a GET-kérés fejlécválaszából származó aktuális entitásállapotmal, vagy * kell lennie a feltétel nélküli frissítéshez.
- parameters
- BackendUpdateParameters
Paraméterek frissítése.
- options
- BackendUpdateOptionalParams
A beállítások paraméterei.
Válaszok
Promise<BackendUpdateResponse>