Workspaces interface
代表工作區的介面。
方法
方法詳細資料
beginCreateOrUpdate(string, string, Workspace, WorkspacesCreateOrUpdateOptionalParams)
建立或更新工作區。
function beginCreateOrUpdate(resourceGroupName: string, workspaceName: string, parameters: Workspace, options?: WorkspacesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Workspace>, Workspace>>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- workspaceName
-
string
工作區的名稱。
- parameters
- Workspace
建立或更新工作區所需的參數。
選項參數。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<Workspace>, Workspace>>
beginCreateOrUpdateAndWait(string, string, Workspace, WorkspacesCreateOrUpdateOptionalParams)
建立或更新工作區。
function beginCreateOrUpdateAndWait(resourceGroupName: string, workspaceName: string, parameters: Workspace, options?: WorkspacesCreateOrUpdateOptionalParams): Promise<Workspace>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- workspaceName
-
string
工作區的名稱。
- parameters
- Workspace
建立或更新工作區所需的參數。
選項參數。
傳回
Promise<Workspace>
beginDelete(string, string, WorkspacesDeleteOptionalParams)
刪除工作區資源。 若要復原工作區,請在相同的訂用帳戶、資源群組和位置中,以相同的名稱再次建立工作區。 名稱會保留 14 天,無法用於另一個工作區。 若要完全移除工作區並釋放名稱,請使用 force 旗標。
function beginDelete(resourceGroupName: string, workspaceName: string, options?: WorkspacesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- workspaceName
-
string
工作區的名稱。
- options
- WorkspacesDeleteOptionalParams
選項參數。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, WorkspacesDeleteOptionalParams)
刪除工作區資源。 若要復原工作區,請在相同的訂用帳戶、資源群組和位置中,以相同的名稱再次建立工作區。 名稱會保留 14 天,無法用於另一個工作區。 若要完全移除工作區並釋放名稱,請使用 force 旗標。
function beginDeleteAndWait(resourceGroupName: string, workspaceName: string, options?: WorkspacesDeleteOptionalParams): Promise<void>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- workspaceName
-
string
工作區的名稱。
- options
- WorkspacesDeleteOptionalParams
選項參數。
傳回
Promise<void>
beginFailback(string, string, WorkspacesFailbackOptionalParams)
停用指定工作區的容錯移轉。
容錯回復作業是非同步的,最多可能需要 30 分鐘才能完成。 您可以使用回應中傳回的 operationId 來檢查作業的狀態。
function beginFailback(resourceGroupName: string, workspaceName: string, options?: WorkspacesFailbackOptionalParams): Promise<SimplePollerLike<OperationState<WorkspacesFailbackHeaders>, WorkspacesFailbackHeaders>>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- workspaceName
-
string
工作區的名稱。
- options
- WorkspacesFailbackOptionalParams
選項參數。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<WorkspacesFailbackHeaders>, WorkspacesFailbackHeaders>>
beginFailbackAndWait(string, string, WorkspacesFailbackOptionalParams)
停用指定工作區的容錯移轉。
容錯回復作業是非同步的,最多可能需要 30 分鐘才能完成。 您可以使用回應中傳回的 operationId 來檢查作業的狀態。
function beginFailbackAndWait(resourceGroupName: string, workspaceName: string, options?: WorkspacesFailbackOptionalParams): Promise<WorkspacesFailbackHeaders>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- workspaceName
-
string
工作區的名稱。
- options
- WorkspacesFailbackOptionalParams
選項參數。
傳回
Promise<WorkspacesFailbackHeaders>
beginFailover(string, string, string, WorkspacesFailoverOptionalParams)
啟用指定工作區的容錯移轉。
指定的複寫位置必須符合此工作區已啟用複寫的位置。 容錯移轉作業是非同步的,最多可能需要 30 分鐘才能完成。 您可以使用回應中傳回的 operationId 來檢查作業的狀態。
function beginFailover(resourceGroupName: string, location: string, workspaceName: string, options?: WorkspacesFailoverOptionalParams): Promise<SimplePollerLike<OperationState<WorkspacesFailoverHeaders>, WorkspacesFailoverHeaders>>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- location
-
string
Azure 區域的名稱。
- workspaceName
-
string
工作區的名稱。
- options
- WorkspacesFailoverOptionalParams
選項參數。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<WorkspacesFailoverHeaders>, WorkspacesFailoverHeaders>>
beginFailoverAndWait(string, string, string, WorkspacesFailoverOptionalParams)
啟用指定工作區的容錯移轉。
指定的複寫位置必須符合此工作區已啟用複寫的位置。 容錯移轉作業是非同步的,最多可能需要 30 分鐘才能完成。 您可以使用回應中傳回的 operationId 來檢查作業的狀態。
function beginFailoverAndWait(resourceGroupName: string, location: string, workspaceName: string, options?: WorkspacesFailoverOptionalParams): Promise<WorkspacesFailoverHeaders>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- location
-
string
Azure 區域的名稱。
- workspaceName
-
string
工作區的名稱。
- options
- WorkspacesFailoverOptionalParams
選項參數。
傳回
Promise<WorkspacesFailoverHeaders>
beginReconcileNSP(string, string, string, WorkspacesReconcileNSPOptionalParams)
協調工作區資源的網路安全性周邊設定。
function beginReconcileNSP(resourceGroupName: string, workspaceName: string, networkSecurityPerimeterConfigurationName: string, options?: WorkspacesReconcileNSPOptionalParams): Promise<SimplePollerLike<OperationState<WorkspacesReconcileNSPHeaders>, WorkspacesReconcileNSPHeaders>>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- workspaceName
-
string
工作區的名稱。
- networkSecurityPerimeterConfigurationName
-
string
網路安全性周邊設定的名稱
選項參數。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<WorkspacesReconcileNSPHeaders>, WorkspacesReconcileNSPHeaders>>
beginReconcileNSPAndWait(string, string, string, WorkspacesReconcileNSPOptionalParams)
協調工作區資源的網路安全性周邊設定。
function beginReconcileNSPAndWait(resourceGroupName: string, workspaceName: string, networkSecurityPerimeterConfigurationName: string, options?: WorkspacesReconcileNSPOptionalParams): Promise<WorkspacesReconcileNSPHeaders>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- workspaceName
-
string
工作區的名稱。
- networkSecurityPerimeterConfigurationName
-
string
網路安全性周邊設定的名稱
選項參數。
傳回
Promise<WorkspacesReconcileNSPHeaders>
get(string, string, WorkspacesGetOptionalParams)
取得工作區實例。
function get(resourceGroupName: string, workspaceName: string, options?: WorkspacesGetOptionalParams): Promise<Workspace>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- workspaceName
-
string
工作區的名稱。
- options
- WorkspacesGetOptionalParams
選項參數。
傳回
Promise<Workspace>
getNSP(string, string, string, WorkspacesGetNSPOptionalParams)
取得網路安全性周邊設定。
function getNSP(resourceGroupName: string, workspaceName: string, networkSecurityPerimeterConfigurationName: string, options?: WorkspacesGetNSPOptionalParams): Promise<NetworkSecurityPerimeterConfiguration>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- workspaceName
-
string
工作區的名稱。
- networkSecurityPerimeterConfigurationName
-
string
網路安全性周邊設定的名稱
- options
- WorkspacesGetNSPOptionalParams
選項參數。
傳回
list(WorkspacesListOptionalParams)
取得訂用帳戶中的工作區。
function list(options?: WorkspacesListOptionalParams): PagedAsyncIterableIterator<Workspace, Workspace[], PageSettings>
參數
- options
- WorkspacesListOptionalParams
選項參數。
傳回
listByResourceGroup(string, WorkspacesListByResourceGroupOptionalParams)
取得資源群組中的工作區。
function listByResourceGroup(resourceGroupName: string, options?: WorkspacesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Workspace, Workspace[], PageSettings>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
選項參數。
傳回
listNSP(string, string, WorkspacesListNSPOptionalParams)
取得指定工作區的 NSP 組態清單。
function listNSP(resourceGroupName: string, workspaceName: string, options?: WorkspacesListNSPOptionalParams): PagedAsyncIterableIterator<NetworkSecurityPerimeterConfiguration, NetworkSecurityPerimeterConfiguration[], PageSettings>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- workspaceName
-
string
工作區的名稱。
- options
- WorkspacesListNSPOptionalParams
選項參數。
傳回
update(string, string, WorkspacePatch, WorkspacesUpdateOptionalParams)
更新工作區。
function update(resourceGroupName: string, workspaceName: string, parameters: WorkspacePatch, options?: WorkspacesUpdateOptionalParams): Promise<Workspace>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- workspaceName
-
string
工作區的名稱。
- parameters
- WorkspacePatch
修補工作區所需的參數。
- options
- WorkspacesUpdateOptionalParams
選項參數。
傳回
Promise<Workspace>