Workspaces interface
Interface representing a Workspaces.
Methods
| begin |
Creates a new workspace. |
| begin |
Creates a new workspace. |
| begin |
Deletes the workspace. |
| begin |
Deletes the workspace. |
| begin |
Updates a workspace. |
| begin |
Updates a workspace. |
| get(string, string, Workspaces |
Gets the workspace. |
| list |
Gets all the workspaces within a resource group. |
| list |
Gets all the workspaces within a subscription. |
Method Details
beginCreateOrUpdate(string, string, Workspace, WorkspacesCreateOrUpdateOptionalParams)
Creates a new workspace.
function beginCreateOrUpdate(resourceGroupName: string, workspaceName: string, parameters: Workspace, options?: WorkspacesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<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
Parameters supplied to the create or update a workspace.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<Workspace>, Workspace>>
beginCreateOrUpdateAndWait(string, string, Workspace, WorkspacesCreateOrUpdateOptionalParams)
Creates a new 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
Parameters supplied to the create or update a workspace.
The options parameters.
Returns
Promise<Workspace>
beginDelete(string, string, WorkspacesDeleteOptionalParams)
Deletes the workspace.
function beginDelete(resourceGroupName: string, workspaceName: string, options?: WorkspacesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<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<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, WorkspacesDeleteOptionalParams)
Deletes the workspace.
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>
beginUpdate(string, string, WorkspaceUpdate, WorkspacesUpdateOptionalParams)
Updates a workspace.
function beginUpdate(resourceGroupName: string, workspaceName: string, parameters: WorkspaceUpdate, options?: WorkspacesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Workspace>, Workspace>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
The name of the workspace.
- parameters
- WorkspaceUpdate
The update to the workspace.
- options
- WorkspacesUpdateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<Workspace>, Workspace>>
beginUpdateAndWait(string, string, WorkspaceUpdate, WorkspacesUpdateOptionalParams)
Updates a workspace.
function beginUpdateAndWait(resourceGroupName: string, workspaceName: string, parameters: WorkspaceUpdate, 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
- WorkspaceUpdate
The update to the workspace.
- options
- WorkspacesUpdateOptionalParams
The options parameters.
Returns
Promise<Workspace>
get(string, string, WorkspacesGetOptionalParams)
Gets the workspace.
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>
listByResourceGroup(string, WorkspacesListByResourceGroupOptionalParams)
Gets all the workspaces within 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
listBySubscription(WorkspacesListBySubscriptionOptionalParams)
Gets all the workspaces within a subscription.
function listBySubscription(options?: WorkspacesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Workspace, Workspace[], PageSettings>Parameters
The options parameters.