Workspaces class
Class representing a Workspaces.
Constructors
| Workspaces(Batch |
Create a Workspaces. |
Methods
Constructor Details
Workspaces(BatchAIManagementClientContext)
Create a Workspaces.
new Workspaces(client: BatchAIManagementClientContext)Parameters
Reference to the service client.
Method Details
beginCreate(string, string, WorkspaceCreateParameters, RequestOptionsBase)
Creates a Workspace.
function beginCreate(resourceGroupName: string, workspaceName: string, parameters: WorkspaceCreateParameters, options?: RequestOptionsBase): Promise<LROPoller>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- workspaceName
-
string
The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- parameters
- WorkspaceCreateParameters
Workspace creation parameters.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<@azure/ms-rest-azure-js.LROPoller>
Promise<msRestAzure.LROPoller>
beginDeleteMethod(string, string, RequestOptionsBase)
Deletes a Workspace.
function beginDeleteMethod(resourceGroupName: string, workspaceName: string, options?: RequestOptionsBase): Promise<LROPoller>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- workspaceName
-
string
The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<@azure/ms-rest-azure-js.LROPoller>
Promise<msRestAzure.LROPoller>
create(string, string, WorkspaceCreateParameters, RequestOptionsBase)
Creates a Workspace.
function create(resourceGroupName: string, workspaceName: string, parameters: WorkspaceCreateParameters, options?: RequestOptionsBase): Promise<WorkspacesCreateResponse>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- workspaceName
-
string
The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- parameters
- WorkspaceCreateParameters
Workspace creation parameters.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<WorkspacesCreateResponse>
Promise<Models.WorkspacesCreateResponse>
deleteMethod(string, string, RequestOptionsBase)
Deletes a Workspace.
function deleteMethod(resourceGroupName: string, workspaceName: string, options?: RequestOptionsBase): Promise<RestResponse>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- workspaceName
-
string
The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<RestResponse>
Promise<msRest.RestResponse>
get(string, string, RequestOptionsBase)
Gets information about a Workspace.
function get(resourceGroupName: string, workspaceName: string, options?: RequestOptionsBase): Promise<WorkspacesGetResponse>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- workspaceName
-
string
The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<WorkspacesGetResponse>
Promise<Models.WorkspacesGetResponse>
get(string, string, RequestOptionsBase, ServiceCallback<Workspace>)
function get(resourceGroupName: string, workspaceName: string, options: RequestOptionsBase, callback: ServiceCallback<Workspace>)Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- workspaceName
-
string
The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
get(string, string, ServiceCallback<Workspace>)
function get(resourceGroupName: string, workspaceName: string, callback: ServiceCallback<Workspace>)Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- workspaceName
-
string
The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- callback
The callback
list(ServiceCallback<WorkspaceListResult>)
function list(callback: ServiceCallback<WorkspaceListResult>)Parameters
- callback
The callback
list(WorkspacesListOptionalParams)
Gets a list of Workspaces associated with the given subscription.
function list(options?: WorkspacesListOptionalParams): Promise<WorkspacesListResponse>Parameters
- options
- WorkspacesListOptionalParams
The optional parameters
Returns
Promise<WorkspacesListResponse>
Promise<Models.WorkspacesListResponse>
list(WorkspacesListOptionalParams, ServiceCallback<WorkspaceListResult>)
function list(options: WorkspacesListOptionalParams, callback: ServiceCallback<WorkspaceListResult>)Parameters
- options
- WorkspacesListOptionalParams
The optional parameters
- callback
The callback
listByResourceGroup(string, ServiceCallback<WorkspaceListResult>)
function listByResourceGroup(resourceGroupName: string, callback: ServiceCallback<WorkspaceListResult>)Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- callback
The callback
listByResourceGroup(string, WorkspacesListByResourceGroupOptionalParams)
Gets a list of Workspaces within the specified resource group.
function listByResourceGroup(resourceGroupName: string, options?: WorkspacesListByResourceGroupOptionalParams): Promise<WorkspacesListByResourceGroupResponse>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
The optional parameters
Returns
Promise<Models.WorkspacesListByResourceGroupResponse>
listByResourceGroup(string, WorkspacesListByResourceGroupOptionalParams, ServiceCallback<WorkspaceListResult>)
function listByResourceGroup(resourceGroupName: string, options: WorkspacesListByResourceGroupOptionalParams, callback: ServiceCallback<WorkspaceListResult>)Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
The optional parameters
- callback
The callback
listByResourceGroupNext(string, RequestOptionsBase)
Gets a list of Workspaces within the specified resource group.
function listByResourceGroupNext(nextPageLink: string, options?: RequestOptionsBase): Promise<WorkspacesListByResourceGroupNextResponse>Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<Models.WorkspacesListByResourceGroupNextResponse>
listByResourceGroupNext(string, RequestOptionsBase, ServiceCallback<WorkspaceListResult>)
function listByResourceGroupNext(nextPageLink: string, options: RequestOptionsBase, callback: ServiceCallback<WorkspaceListResult>)Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
listByResourceGroupNext(string, ServiceCallback<WorkspaceListResult>)
function listByResourceGroupNext(nextPageLink: string, callback: ServiceCallback<WorkspaceListResult>)Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- callback
The callback
listNext(string, RequestOptionsBase)
Gets a list of Workspaces associated with the given subscription.
function listNext(nextPageLink: string, options?: RequestOptionsBase): Promise<WorkspacesListNextResponse>Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<WorkspacesListNextResponse>
Promise<Models.WorkspacesListNextResponse>
listNext(string, RequestOptionsBase, ServiceCallback<WorkspaceListResult>)
function listNext(nextPageLink: string, options: RequestOptionsBase, callback: ServiceCallback<WorkspaceListResult>)Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
listNext(string, ServiceCallback<WorkspaceListResult>)
function listNext(nextPageLink: string, callback: ServiceCallback<WorkspaceListResult>)Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- callback
The callback
update(string, string, ServiceCallback<Workspace>)
function update(resourceGroupName: string, workspaceName: string, callback: ServiceCallback<Workspace>)Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- workspaceName
-
string
The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- callback
The callback
update(string, string, WorkspacesUpdateOptionalParams)
Updates properties of a Workspace.
function update(resourceGroupName: string, workspaceName: string, options?: WorkspacesUpdateOptionalParams): Promise<WorkspacesUpdateResponse>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- workspaceName
-
string
The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- options
- WorkspacesUpdateOptionalParams
The optional parameters
Returns
Promise<WorkspacesUpdateResponse>
Promise<Models.WorkspacesUpdateResponse>
update(string, string, WorkspacesUpdateOptionalParams, ServiceCallback<Workspace>)
function update(resourceGroupName: string, workspaceName: string, options: WorkspacesUpdateOptionalParams, callback: ServiceCallback<Workspace>)Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- workspaceName
-
string
The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- options
- WorkspacesUpdateOptionalParams
The optional parameters
- callback
The callback