Workspaces interface
Interface representing a Workspaces.
Methods
| begin |
Create or update a workspace. |
| begin |
Create or update a workspace. |
| begin |
Deletes a workspace resource. To recover the workspace, create it again with the same name, in the same subscription, resource group and location. The name is kept for 14 days and cannot be used for another workspace. To remove the workspace completely and release the name, use the force flag. |
| begin |
Deletes a workspace resource. To recover the workspace, create it again with the same name, in the same subscription, resource group and location. The name is kept for 14 days and cannot be used for another workspace. To remove the workspace completely and release the name, use the force flag. |
| get(string, string, Workspaces |
Gets a workspace instance. |
| list(Workspaces |
Gets the workspaces in a subscription. |
| list |
Gets workspaces in a resource group. |
| update(string, string, Workspace |
Updates a workspace. |
Method Details
beginCreateOrUpdate(string, string, Workspace, WorkspacesCreateOrUpdateOptionalParams)
Create or update a workspace.
function beginCreateOrUpdate(resourceGroupName: string, workspaceName: string, parameters: Workspace, options?: WorkspacesCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<Workspace>, Workspace>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the workspace.
- parameters
- Workspace
The parameters required to create or update a workspace.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<Workspace>, Workspace>>
beginCreateOrUpdateAndWait(string, string, Workspace, WorkspacesCreateOrUpdateOptionalParams)
Create or update a workspace.
function beginCreateOrUpdateAndWait(resourceGroupName: string, workspaceName: string, parameters: Workspace, options?: WorkspacesCreateOrUpdateOptionalParams): Promise<Workspace>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the workspace.
- parameters
- Workspace
The parameters required to create or update a workspace.
The options parameters.
Returns
Promise<Workspace>
beginDelete(string, string, WorkspacesDeleteOptionalParams)
Deletes a workspace resource. To recover the workspace, create it again with the same name, in the same subscription, resource group and location. The name is kept for 14 days and cannot be used for another workspace. To remove the workspace completely and release the name, use the force flag.
function beginDelete(resourceGroupName: string, workspaceName: string, options?: WorkspacesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the workspace.
- options
- WorkspacesDeleteOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeleteAndWait(string, string, WorkspacesDeleteOptionalParams)
Deletes a workspace resource. To recover the workspace, create it again with the same name, in the same subscription, resource group and location. The name is kept for 14 days and cannot be used for another workspace. To remove the workspace completely and release the name, use the force flag.
function beginDeleteAndWait(resourceGroupName: string, workspaceName: string, options?: WorkspacesDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the workspace.
- options
- WorkspacesDeleteOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, WorkspacesGetOptionalParams)
Gets a workspace instance.
function get(resourceGroupName: string, workspaceName: string, options?: WorkspacesGetOptionalParams): Promise<Workspace>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the workspace.
- options
- WorkspacesGetOptionalParams
The options parameters.
Returns
Promise<Workspace>
list(WorkspacesListOptionalParams)
Gets the workspaces in a subscription.
function list(options?: WorkspacesListOptionalParams): PagedAsyncIterableIterator<Workspace, Workspace[], PageSettings>Parameters
- options
- WorkspacesListOptionalParams
The options parameters.
Returns
listByResourceGroup(string, WorkspacesListByResourceGroupOptionalParams)
Gets workspaces in a resource group.
function listByResourceGroup(resourceGroupName: string, options?: WorkspacesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Workspace, Workspace[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
The options parameters.
Returns
update(string, string, WorkspacePatch, WorkspacesUpdateOptionalParams)
Updates a workspace.
function update(resourceGroupName: string, workspaceName: string, parameters: WorkspacePatch, options?: WorkspacesUpdateOptionalParams): Promise<Workspace>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the workspace.
- parameters
- WorkspacePatch
The parameters required to patch a workspace.
- options
- WorkspacesUpdateOptionalParams
The options parameters.
Returns
Promise<Workspace>