Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Experiments

Package version

Class representing a Experiments.

Hierarchy

  • Experiments

Index

Constructors

Methods

Constructors

constructor

Methods

beginCreate

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

  • Creates an Experiment.

    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.

    • experimentName: string

      The name of the experiment. Experiment 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>

beginDeleteMethod

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

  • Deletes an Experiment.

    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.

    • experimentName: string

      The name of the experiment. Experiment 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, experimentName: string, options?: msRest.RequestOptionsBase): Promise<Models.ExperimentsCreateResponse>

  • Creates an Experiment.

    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.

    • experimentName: string

      The name of the experiment. Experiment 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.ExperimentsCreateResponse>

    Promise<Models.ExperimentsCreateResponse>

deleteMethod

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

  • Deletes an Experiment.

    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.

    • experimentName: string

      The name of the experiment. Experiment 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, experimentName: string, options?: msRest.RequestOptionsBase): Promise<Models.ExperimentsGetResponse>
  • get(resourceGroupName: string, workspaceName: string, experimentName: string, callback: msRest.ServiceCallback<Experiment>): void
  • get(resourceGroupName: string, workspaceName: string, experimentName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<Experiment>): void

  • Gets information about an Experiment.

    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.

    • experimentName: string

      The name of the experiment. Experiment 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.ExperimentsGetResponse>

    Promise<Models.ExperimentsGetResponse>

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

    • experimentName: string

      The name of the experiment. Experiment 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<Experiment>

      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.

    • experimentName: string

      The name of the experiment. Experiment 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<Experiment>

      The callback

    Returns void

listByWorkspace

  • listByWorkspace(resourceGroupName: string, workspaceName: string, options?: Models.ExperimentsListByWorkspaceOptionalParams): Promise<Models.ExperimentsListByWorkspaceResponse>
  • listByWorkspace(resourceGroupName: string, workspaceName: string, callback: msRest.ServiceCallback<ExperimentListResult>): void
  • listByWorkspace(resourceGroupName: string, workspaceName: string, options: ExperimentsListByWorkspaceOptionalParams, callback: msRest.ServiceCallback<ExperimentListResult>): void

  • Gets a list of Experiments within the specified 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.ExperimentsListByWorkspaceOptionalParams

    Returns Promise<Models.ExperimentsListByWorkspaceResponse>

    Promise<Models.ExperimentsListByWorkspaceResponse>

  • 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<ExperimentListResult>

      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: ExperimentsListByWorkspaceOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<ExperimentListResult>

      The callback

    Returns void

listByWorkspaceNext

  • listByWorkspaceNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.ExperimentsListByWorkspaceNextResponse>
  • listByWorkspaceNext(nextPageLink: string, callback: msRest.ServiceCallback<ExperimentListResult>): void
  • listByWorkspaceNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ExperimentListResult>): void

  • Gets a list of Experiments within the specified Workspace.

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ExperimentsListByWorkspaceNextResponse>

    Promise<Models.ExperimentsListByWorkspaceNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<ExperimentListResult>

      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<ExperimentListResult>

      The callback

    Returns void

Generated using TypeDoc