ExpansionJobs interface

Interface representing a ExpansionJobs.

Method Details

beginCreateOrUpdate(string, string, string, ExpansionJob, ExpansionJobsCreateOrUpdateOptionalParams)

Create or update an expansion job.

function beginCreateOrUpdate(resourceGroupName: string, amlFilesystemName: string, expansionJobName: string, expansionJob: ExpansionJob, options?: ExpansionJobsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ExpansionJob>, ExpansionJob>>

Parameters

resourceGroupName

string

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

amlFilesystemName

string

Name for the AML file system. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric.

expansionJobName

string

Name for the expansion job. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric.

expansionJob
ExpansionJob

Object containing the user-selectable properties of the expansion job. If read-only properties are included, they must match the existing values of those properties.

options
ExpansionJobsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ExpansionJob>, ExpansionJob>>

beginCreateOrUpdateAndWait(string, string, string, ExpansionJob, ExpansionJobsCreateOrUpdateOptionalParams)

Create or update an expansion job.

function beginCreateOrUpdateAndWait(resourceGroupName: string, amlFilesystemName: string, expansionJobName: string, expansionJob: ExpansionJob, options?: ExpansionJobsCreateOrUpdateOptionalParams): Promise<ExpansionJob>

Parameters

resourceGroupName

string

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

amlFilesystemName

string

Name for the AML file system. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric.

expansionJobName

string

Name for the expansion job. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric.

expansionJob
ExpansionJob

Object containing the user-selectable properties of the expansion job. If read-only properties are included, they must match the existing values of those properties.

options
ExpansionJobsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<ExpansionJob>

beginDelete(string, string, string, ExpansionJobsDeleteOptionalParams)

Schedules an expansion job for deletion.

function beginDelete(resourceGroupName: string, amlFilesystemName: string, expansionJobName: string, options?: ExpansionJobsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<ExpansionJobsDeleteHeaders>, ExpansionJobsDeleteHeaders>>

Parameters

resourceGroupName

string

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

amlFilesystemName

string

Name for the AML file system. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric.

expansionJobName

string

Name for the expansion job. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric.

options
ExpansionJobsDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ExpansionJobsDeleteHeaders>, ExpansionJobsDeleteHeaders>>

beginDeleteAndWait(string, string, string, ExpansionJobsDeleteOptionalParams)

Schedules an expansion job for deletion.

function beginDeleteAndWait(resourceGroupName: string, amlFilesystemName: string, expansionJobName: string, options?: ExpansionJobsDeleteOptionalParams): Promise<ExpansionJobsDeleteHeaders>

Parameters

resourceGroupName

string

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

amlFilesystemName

string

Name for the AML file system. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric.

expansionJobName

string

Name for the expansion job. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric.

options
ExpansionJobsDeleteOptionalParams

The options parameters.

Returns

beginUpdate(string, string, string, ExpansionJobUpdate, ExpansionJobsUpdateOptionalParams)

Update an expansion job instance.

function beginUpdate(resourceGroupName: string, amlFilesystemName: string, expansionJobName: string, expansionJob: ExpansionJobUpdate, options?: ExpansionJobsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ExpansionJob>, ExpansionJob>>

Parameters

resourceGroupName

string

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

amlFilesystemName

string

Name for the AML file system. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric.

expansionJobName

string

Name for the expansion job. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric.

expansionJob
ExpansionJobUpdate

Object containing the user-selectable properties of the expansion job. If read-only properties are included, they must match the existing values of those properties.

options
ExpansionJobsUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ExpansionJob>, ExpansionJob>>

beginUpdateAndWait(string, string, string, ExpansionJobUpdate, ExpansionJobsUpdateOptionalParams)

Update an expansion job instance.

function beginUpdateAndWait(resourceGroupName: string, amlFilesystemName: string, expansionJobName: string, expansionJob: ExpansionJobUpdate, options?: ExpansionJobsUpdateOptionalParams): Promise<ExpansionJob>

Parameters

resourceGroupName

string

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

amlFilesystemName

string

Name for the AML file system. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric.

expansionJobName

string

Name for the expansion job. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric.

expansionJob
ExpansionJobUpdate

Object containing the user-selectable properties of the expansion job. If read-only properties are included, they must match the existing values of those properties.

options
ExpansionJobsUpdateOptionalParams

The options parameters.

Returns

Promise<ExpansionJob>

get(string, string, string, ExpansionJobsGetOptionalParams)

Returns an expansion job.

function get(resourceGroupName: string, amlFilesystemName: string, expansionJobName: string, options?: ExpansionJobsGetOptionalParams): Promise<ExpansionJob>

Parameters

resourceGroupName

string

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

amlFilesystemName

string

Name for the AML file system. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric.

expansionJobName

string

Name for the expansion job. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric.

options
ExpansionJobsGetOptionalParams

The options parameters.

Returns

Promise<ExpansionJob>

listByAmlFilesystem(string, string, ExpansionJobsListByAmlFilesystemOptionalParams)

Returns all the expansion jobs the user has access to under an AML File System.

function listByAmlFilesystem(resourceGroupName: string, amlFilesystemName: string, options?: ExpansionJobsListByAmlFilesystemOptionalParams): PagedAsyncIterableIterator<ExpansionJob, ExpansionJob[], PageSettings>

Parameters

resourceGroupName

string

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

amlFilesystemName

string

Name for the AML file system. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric.

options
ExpansionJobsListByAmlFilesystemOptionalParams

The options parameters.

Returns