disk_migration_jobs

Creates, updates, deletes, gets or lists a disk_migration_jobs resource.

Overview

Name	disk_migration_jobs
Type	Resource
Id	azure_stack.compute_admin.disk_migration_jobs

Fields

The following fields are returned by SELECT queries:

get

OK -- The disk migration job has been returned.

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties	object	Disk migration properties.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list

OK -- The list of disk migration jobs has been returned.

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties	object	Disk migration properties.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, location, migrationId		Returns the requested disk migration job.
list	select	subscriptionId, location	status	Returns a list of disk migration jobs.
create	insert	subscriptionId, location, migrationId	targetShare, targetScaleUnit, targetVolumeLabel	Create a disk migration job.
cancel	exec	subscriptionId, location, migrationId		Cancel a disk migration job.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
location	string	The name of Azure region.
migrationId	string	The migration job guid name.
subscriptionId	string	The ID of the target subscription.
status	string	The parameters of disk migration job status.
targetScaleUnit	string	The target scale unit name.
targetShare	string	The target share name.
targetVolumeLabel	string	The target volume label.

SELECT examples

get

Returns the requested disk migration job.

SELECT
id,
name,
properties,
type
FROM azure_stack.compute_admin.disk_migration_jobs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND location = '{{ location }}' -- required
AND migrationId = '{{ migrationId }}' -- required
;

list

Returns a list of disk migration jobs.

SELECT
id,
name,
properties,
type
FROM azure_stack.compute_admin.disk_migration_jobs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND location = '{{ location }}' -- required
AND status = '{{ status }}'
;

INSERT examples

create

Create a disk migration job.

INSERT INTO azure_stack.compute_admin.disk_migration_jobs (
subscriptionId,
location,
migrationId,
targetShare,
targetScaleUnit,
targetVolumeLabel
)
SELECT 
'{{ subscriptionId }}',
'{{ location }}',
'{{ migrationId }}',
'{{ targetShare }}',
'{{ targetScaleUnit }}',
'{{ targetVolumeLabel }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: disk_migration_jobs
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the disk_migration_jobs resource.
    - name: location
      value: string
      description: Required parameter for the disk_migration_jobs resource.
    - name: migrationId
      value: string
      description: Required parameter for the disk_migration_jobs resource.
    - name: targetShare
      value: string
      description: The target share name.
    - name: targetScaleUnit
      value: string
      description: The target scale unit name.
    - name: targetVolumeLabel
      value: string
      description: The target volume label.

Lifecycle Methods

cancel

Cancel a disk migration job.

EXEC azure_stack.compute_admin.disk_migration_jobs.cancel 
@subscriptionId='{{ subscriptionId }}' --required, 
@location='{{ location }}' --required, 
@migrationId='{{ migrationId }}' --required
;