Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Workspaces

Package version

Class representing a Workspaces.

Hierarchy

  • Workspaces

Index

Constructors

Methods

Constructors

constructor

Methods

beginCreate

  • beginCreate(resourceGroupName: string, workspaceName: string, parameters: WorkspaceCreateParameters, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

  • Creates a 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.

    • parameters: WorkspaceCreateParameters

      Workspace creation parameters.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

beginDeleteMethod

  • beginDeleteMethod(resourceGroupName: string, workspaceName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

  • Deletes a 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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

create

  • create(resourceGroupName: string, workspaceName: string, parameters: WorkspaceCreateParameters, options?: msRest.RequestOptionsBase): Promise<Models.WorkspacesCreateResponse>

  • Creates a 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.

    • parameters: WorkspaceCreateParameters

      Workspace creation parameters.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.WorkspacesCreateResponse>

    Promise<Models.WorkspacesCreateResponse>

deleteMethod

  • deleteMethod(resourceGroupName: string, workspaceName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>

  • Deletes a 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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

get

  • get(resourceGroupName: string, workspaceName: string, options?: msRest.RequestOptionsBase): Promise<Models.WorkspacesGetResponse>
  • get(resourceGroupName: string, workspaceName: string, callback: msRest.ServiceCallback<Workspace>): void
  • get(resourceGroupName: string, workspaceName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<Workspace>): void

  • Gets information about a 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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.WorkspacesGetResponse>

    Promise<Models.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.

    • callback: msRest.ServiceCallback<Workspace>

      The callback

    Returns void

  • 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: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<Workspace>

      The callback

    Returns void

list

listByResourceGroup

  • listByResourceGroup(resourceGroupName: string, options?: Models.WorkspacesListByResourceGroupOptionalParams): Promise<Models.WorkspacesListByResourceGroupResponse>
  • listByResourceGroup(resourceGroupName: string, callback: msRest.ServiceCallback<WorkspaceListResult>): void
  • listByResourceGroup(resourceGroupName: string, options: WorkspacesListByResourceGroupOptionalParams, callback: msRest.ServiceCallback<WorkspaceListResult>): void

  • Gets a list of Workspaces within the specified resource group.

    Parameters

    • resourceGroupName: string

      Name of the resource group to which the resource belongs.

    • Optional options: Models.WorkspacesListByResourceGroupOptionalParams

    Returns Promise<Models.WorkspacesListByResourceGroupResponse>

    Promise<Models.WorkspacesListByResourceGroupResponse>

  • Parameters

    • resourceGroupName: string

      Name of the resource group to which the resource belongs.

    • callback: msRest.ServiceCallback<WorkspaceListResult>

      The callback

    Returns void

  • Parameters

    Returns void

listByResourceGroupNext

  • listByResourceGroupNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.WorkspacesListByResourceGroupNextResponse>
  • listByResourceGroupNext(nextPageLink: string, callback: msRest.ServiceCallback<WorkspaceListResult>): void
  • listByResourceGroupNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<WorkspaceListResult>): void

  • Gets a list of Workspaces within the specified resource group.

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.WorkspacesListByResourceGroupNextResponse>

    Promise<Models.WorkspacesListByResourceGroupNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<WorkspaceListResult>

      The callback

    Returns void

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<WorkspaceListResult>

      The callback

    Returns void

listNext

  • listNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.WorkspacesListNextResponse>
  • listNext(nextPageLink: string, callback: msRest.ServiceCallback<WorkspaceListResult>): void
  • listNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<WorkspaceListResult>): void

  • Gets a list of Workspaces associated with the given subscription.

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.WorkspacesListNextResponse>

    Promise<Models.WorkspacesListNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<WorkspaceListResult>

      The callback

    Returns void

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<WorkspaceListResult>

      The callback

    Returns void

update

  • update(resourceGroupName: string, workspaceName: string, options?: Models.WorkspacesUpdateOptionalParams): Promise<Models.WorkspacesUpdateResponse>
  • update(resourceGroupName: string, workspaceName: string, callback: msRest.ServiceCallback<Workspace>): void
  • update(resourceGroupName: string, workspaceName: string, options: WorkspacesUpdateOptionalParams, callback: msRest.ServiceCallback<Workspace>): void

  • Updates properties of a 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.

    • Optional options: Models.WorkspacesUpdateOptionalParams

    Returns Promise<Models.WorkspacesUpdateResponse>

    Promise<Models.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.

    • callback: msRest.ServiceCallback<Workspace>

      The callback

    Returns void

  • 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: msRest.ServiceCallback<Workspace>

      The callback

    Returns void

Generated using TypeDoc