WorkspaceBackend interface
Interfejs reprezentujący element WorkspaceBackend.
Metody
| create |
Tworzy lub aktualizuje zaplecze. |
| delete(string, string, string, string, string, Workspace |
Usuwa określone zaplecze. |
| get(string, string, string, string, Workspace |
Pobiera szczegóły zaplecza określonego przez jego identyfikator. |
| get |
Pobiera wersję stanu jednostki (Etag) zaplecza określonego przez jego identyfikator. |
| list |
Wyświetla listę kolekcji zapleczy w określonym obszarze roboczym. |
| update(string, string, string, string, string, Backend |
Aktualizuje istniejące zaplecze. |
Szczegóły metody
createOrUpdate(string, string, string, string, BackendContract, WorkspaceBackendCreateOrUpdateOptionalParams)
Tworzy lub aktualizuje zaplecze.
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, backendId: string, parameters: BackendContract, options?: WorkspaceBackendCreateOrUpdateOptionalParams): Promise<WorkspaceBackendCreateOrUpdateResponse>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- workspaceId
-
string
Identyfikator obszaru roboczego. Musi być unikatowa w bieżącym wystąpieniu 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
delete(string, string, string, string, string, WorkspaceBackendDeleteOptionalParams)
Usuwa określone zaplecze.
function delete(resourceGroupName: string, serviceName: string, workspaceId: string, backendId: string, ifMatch: string, options?: WorkspaceBackendDeleteOptionalParams): Promise<void>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- workspaceId
-
string
Identyfikator obszaru roboczego. Musi być unikatowa w bieżącym wystąpieniu 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.
Parametry opcji.
Zwraca
Promise<void>
get(string, string, string, string, WorkspaceBackendGetOptionalParams)
Pobiera szczegóły zaplecza określonego przez jego identyfikator.
function get(resourceGroupName: string, serviceName: string, workspaceId: string, backendId: string, options?: WorkspaceBackendGetOptionalParams): Promise<WorkspaceBackendGetResponse>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- workspaceId
-
string
Identyfikator obszaru roboczego. Musi być unikatowa w bieżącym wystąpieniu 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<WorkspaceBackendGetResponse>
getEntityTag(string, string, string, string, WorkspaceBackendGetEntityTagOptionalParams)
Pobiera wersję stanu jednostki (Etag) zaplecza określonego przez jego identyfikator.
function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, backendId: string, options?: WorkspaceBackendGetEntityTagOptionalParams): Promise<WorkspaceBackendGetEntityTagHeaders>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- workspaceId
-
string
Identyfikator obszaru roboczego. Musi być unikatowa w bieżącym wystąpieniu 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<WorkspaceBackendGetEntityTagHeaders>
listByWorkspace(string, string, string, WorkspaceBackendListByWorkspaceOptionalParams)
Wyświetla listę kolekcji zapleczy w określonym obszarze roboczym.
function listByWorkspace(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceBackendListByWorkspaceOptionalParams): 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.
- workspaceId
-
string
Identyfikator obszaru roboczego. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
Parametry opcji.
Zwraca
update(string, string, string, string, string, BackendUpdateParameters, WorkspaceBackendUpdateOptionalParams)
Aktualizuje istniejące zaplecze.
function update(resourceGroupName: string, serviceName: string, workspaceId: string, backendId: string, ifMatch: string, parameters: BackendUpdateParameters, options?: WorkspaceBackendUpdateOptionalParams): Promise<WorkspaceBackendUpdateResponse>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- workspaceId
-
string
Identyfikator obszaru roboczego. Musi być unikatowa w bieżącym wystąpieniu 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.
Parametry opcji.
Zwraca
Promise<WorkspaceBackendUpdateResponse>