Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Workspaces

Package version

Class representing a Workspaces.

Hierarchy

  • Workspaces

Index

Constructors

Methods

Constructors

constructor

Methods

beginCreateOrUpdate

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

  • Creates a new workspace.

    Parameters

    • parameters: Workspace

      Parameters supplied to the create or update a workspace.

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • workspaceName: string

      The name of the workspace.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

beginDeleteMethod

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

  • Deletes the workspace.

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • workspaceName: string

      The name of the workspace.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

beginUpdate

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

  • Updates a workspace.

    Parameters

    • parameters: WorkspaceUpdate

      The update to the workspace.

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • workspaceName: string

      The name of the workspace.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

createOrUpdate

  • createOrUpdate(parameters: Workspace, resourceGroupName: string, workspaceName: string, options?: msRest.RequestOptionsBase): Promise<Models.WorkspacesCreateOrUpdateResponse>

  • Creates a new workspace.

    Parameters

    • parameters: Workspace

      Parameters supplied to the create or update a workspace.

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • workspaceName: string

      The name of the workspace.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.WorkspacesCreateOrUpdateResponse>

    Promise<Models.WorkspacesCreateOrUpdateResponse>

deleteMethod

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

  • Deletes the workspace.

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • workspaceName: string

      The name of the workspace.

    • 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 the workspace.

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • workspaceName: string

      The name of the workspace.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.WorkspacesGetResponse>

    Promise<Models.WorkspacesGetResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • workspaceName: string

      The name of the workspace.

    • callback: msRest.ServiceCallback<Workspace>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • workspaceName: string

      The name of the workspace.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<Workspace>

      The callback

    Returns void

listByResourceGroup

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

  • Gets all the workspaces within a resource group.

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.WorkspacesListByResourceGroupResponse>

    Promise<Models.WorkspacesListByResourceGroupResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • callback: msRest.ServiceCallback<WorkspaceListResult>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<WorkspaceListResult>

      The callback

    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 all the workspaces within a 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

listBySubscription

  • listBySubscription(options?: msRest.RequestOptionsBase): Promise<Models.WorkspacesListBySubscriptionResponse>
  • listBySubscription(callback: msRest.ServiceCallback<WorkspaceListResult>): void
  • listBySubscription(options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<WorkspaceListResult>): void

listBySubscriptionNext

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

  • Gets all the workspaces within a subscription.

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.WorkspacesListBySubscriptionNextResponse>

    Promise<Models.WorkspacesListBySubscriptionNextResponse>

  • 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(parameters: WorkspaceUpdate, resourceGroupName: string, workspaceName: string, options?: msRest.RequestOptionsBase): Promise<Models.WorkspacesUpdateResponse>

  • Updates a workspace.

    Parameters

    • parameters: WorkspaceUpdate

      The update to the workspace.

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • workspaceName: string

      The name of the workspace.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.WorkspacesUpdateResponse>

    Promise<Models.WorkspacesUpdateResponse>

Generated using TypeDoc