Backend interface
Interfejs reprezentujący zaplecze.
Metody
Szczegóły metody
createOrUpdate(string, string, string, BackendContract, BackendCreateOrUpdateOptionalParams)
Tworzy lub aktualizuje zaplecze.
function createOrUpdate(resourceGroupName: string, serviceName: string, backendId: string, parameters: BackendContract, options?: BackendCreateOrUpdateOptionalParams): Promise<BackendCreateOrUpdateResponse>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- backendId
-
string
Identyfikator jednostki zaplecza. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
- parameters
- BackendContract
Utwórz parametry.
Parametry opcji.
Zwraca
Promise<BackendCreateOrUpdateResponse>
delete(string, string, string, string, BackendDeleteOptionalParams)
Usuwa określone zaplecze.
function delete(resourceGroupName: string, serviceName: string, backendId: string, ifMatch: string, options?: BackendDeleteOptionalParams): Promise<void>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- backendId
-
string
Identyfikator jednostki zaplecza. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
- ifMatch
-
string
Element ETag jednostki. Element ETag powinien być zgodny z bieżącym stanem jednostki z odpowiedzi nagłówka żądania GET lub powinien być * dla bezwarunkowej aktualizacji.
- options
- BackendDeleteOptionalParams
Parametry opcji.
Zwraca
Promise<void>
get(string, string, string, BackendGetOptionalParams)
Pobiera szczegóły zaplecza określonego przez jego identyfikator.
function get(resourceGroupName: string, serviceName: string, backendId: string, options?: BackendGetOptionalParams): Promise<BackendGetResponse>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- backendId
-
string
Identyfikator jednostki zaplecza. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
- options
- BackendGetOptionalParams
Parametry opcji.
Zwraca
Promise<BackendGetResponse>
getEntityTag(string, string, string, BackendGetEntityTagOptionalParams)
Pobiera wersję stanu jednostki (Etag) zaplecza określonego przez jego identyfikator.
function getEntityTag(resourceGroupName: string, serviceName: string, backendId: string, options?: BackendGetEntityTagOptionalParams): Promise<BackendGetEntityTagHeaders>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- backendId
-
string
Identyfikator jednostki zaplecza. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
Parametry opcji.
Zwraca
Promise<BackendGetEntityTagHeaders>
listByService(string, string, BackendListByServiceOptionalParams)
Wyświetla kolekcję zapleczy w określonym wystąpieniu usługi.
function listByService(resourceGroupName: string, serviceName: string, options?: BackendListByServiceOptionalParams): PagedAsyncIterableIterator<BackendContract, BackendContract[], PageSettings>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
Parametry opcji.
Zwraca
reconnect(string, string, string, BackendReconnectOptionalParams)
Powiadamia bramę usługi API Management o utworzeniu nowego połączenia z zapleczem po upływie określonego limitu czasu. Jeśli nie określono limitu czasu, zostanie użyty limit czasu 2 minut.
function reconnect(resourceGroupName: string, serviceName: string, backendId: string, options?: BackendReconnectOptionalParams): Promise<void>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- backendId
-
string
Identyfikator jednostki zaplecza. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
- options
- BackendReconnectOptionalParams
Parametry opcji.
Zwraca
Promise<void>
update(string, string, string, string, BackendUpdateParameters, BackendUpdateOptionalParams)
Aktualizuje istniejące zaplecze.
function update(resourceGroupName: string, serviceName: string, backendId: string, ifMatch: string, parameters: BackendUpdateParameters, options?: BackendUpdateOptionalParams): Promise<BackendUpdateResponse>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- backendId
-
string
Identyfikator jednostki zaplecza. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
- ifMatch
-
string
Element ETag jednostki. Element ETag powinien być zgodny z bieżącym stanem jednostki z odpowiedzi nagłówka żądania GET lub powinien być * dla bezwarunkowej aktualizacji.
- parameters
- BackendUpdateParameters
Aktualizuj parametry.
- options
- BackendUpdateOptionalParams
Parametry opcji.
Zwraca
Promise<BackendUpdateResponse>