Skip to main content

bulk_actions

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

Overview

Namebulk_actions
TypeResource
Idazure.compute_bulk_actions.bulk_actions

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstringFully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
namestringThe name of the resource.
capacityintegerTotal capacity to achieve. It can be in terms of VMs or vCPUs. Required.
capacityTypestringSpecifies capacity type for launching instances. It can be in terms of VMs or vCPUs. Known values are: "VM" and "VCpu". (VM, VCpu)
computeProfileobjectCompute Profile to configure the Virtual Machines. Required.
identityobjectThe managed service identities assigned to this resource.
planobjectDetails of the resource plan.
priorityProfileobjectConfiguration Options for Regular or Spot instances in LaunchBulkInstancesOperation. Required.
provisioningStatestringThe status of the last operation. Known values are: "Creating", "Succeeded", "Failed", "Deleting", and "Canceled". (Creating, Succeeded, Failed, Deleting, Canceled)
retryPolicyobjectRetry policy the user can pass.
systemDataobjectAzure Resource Manager metadata containing createdBy and modifiedBy information.
tagsobjectResource tags.
typestringThe type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
vmAttributesobjectAttributes to launch instances.
vmSizesProfilearrayList of VM sizes supported for LaunchBulkInstancesOperation.
zoneAllocationPolicyobjectZone Allocation Policy for launching instances.
zonesarrayZones in which the LaunchBulkInstancesOperation is available.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectresource_group_name, location, name, subscription_idGets an instance of LaunchBulkInstancesOperations.
list_by_resource_groupselectresource_group_name, location, subscription_idList LaunchBulkInstancesOperation resources by resource group.
get_operation_statusselectlocation, id, subscription_idGet the status of a LaunchBulkInstancesOperation.
list_by_subscriptionselectlocation, subscription_idList LaunchBulkInstancesOperation resources by subscriptionId.
create_or_updateinsertresource_group_name, location, name, subscription_idCreates or updates LaunchBulkInstancesOperations.
create_or_updatereplaceresource_group_name, location, name, subscription_idCreates or updates LaunchBulkInstancesOperations.
deletedeleteresource_group_name, location, name, subscription_iddeleteInstancesDeletes LaunchBulkInstancesOperations.
list_virtual_machinesexecresource_group_name, location, name, subscription_id$filter, $skiptokenList VirtualMachine resources of a LaunchBulkInstancesOperation.
cancelexecresource_group_name, location, name, subscription_idCancels LaunchBulkInstancesOperation instances that have not yet launched.
virtual_machines_execute_deallocateexeclocation, subscription_id, executionParameters, correlationidVirtualMachinesExecuteDeallocate: Execute deallocate operation for a batch of virtual machines, this operation is triggered as soon as Computeschedule receives it.
virtual_machines_execute_hibernateexeclocation, subscription_id, executionParameters, correlationidVirtualMachinesExecuteHibernate: Execute hibernate operation for a batch of virtual machines, this operation is triggered as soon as Computeschedule receives it.
virtual_machines_execute_startexeclocation, subscription_id, executionParameters, correlationidVirtualMachinesExecuteStart: Execute start operation for a batch of virtual machines, this operation is triggered as soon as Computeschedule receives it.
virtual_machines_execute_createexeclocation, subscription_id, resourceConfigParameters, executionParametersVirtualMachinesExecuteCreate: Execute create operation for a batch of virtual machines, this operation is triggered as soon as Computeschedule receives it.
virtual_machines_execute_deleteexeclocation, subscription_id, executionParameters, correlationidVirtualMachinesExecuteDelete: Execute delete operation for a batch of virtual machines, this operation is triggered as soon as Computeschedule receives it.
virtual_machines_get_operation_statusexeclocation, subscription_id, operationIds, correlationidVirtualMachinesGetOperationStatus: Polling endpoint to read status of operations performed on virtual machines.
virtual_machines_cancel_operationsexeclocation, subscription_id, operationIds, correlationidVirtualMachinesCancelOperations: Cancel a previously submitted (start/deallocate/hibernate) request.

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.

NameDatatypeDescription
idstringThe async operation id. Required.
locationstringThe location name. Required.
namestringThe name of the LaunchBulkInstancesOperation. Required.
resource_group_namestringThe name of the resource group. The name is case insensitive. Required.
subscription_idstring
$filterstringFilter expression to filter the virtual machines. Default value is None.
$skiptokenstringSkip token for pagination. Uses the token from a previous response to fetch the next page of results. Default value is None.
deleteInstancesbooleanWhen true, deletes all virtual machines created by this BulkAction Operation. Default value is None.

SELECT examples

Gets an instance of LaunchBulkInstancesOperations.

SELECT
id,
name,
capacity,
capacityType,
computeProfile,
identity,
plan,
priorityProfile,
provisioningState,
retryPolicy,
systemData,
tags,
type,
vmAttributes,
vmSizesProfile,
zoneAllocationPolicy,
zones
FROM azure.compute_bulk_actions.bulk_actions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND location = '{{ location }}' -- required
AND name = '{{ name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

Creates or updates LaunchBulkInstancesOperations.

INSERT INTO azure.compute_bulk_actions.bulk_actions (
properties,
zones,
tags,
identity,
plan,
resource_group_name,
location,
name,
subscription_id
)
SELECT
'{{ properties }}',
'{{ zones }}',
'{{ tags }}',
'{{ identity }}',
'{{ plan }}',
'{{ resource_group_name }}',
'{{ location }}',
'{{ name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
plan,
properties,
systemData,
tags,
type,
zones
;

REPLACE examples

Creates or updates LaunchBulkInstancesOperations.

REPLACE azure.compute_bulk_actions.bulk_actions
SET
properties = '{{ properties }}',
zones = '{{ zones }}',
tags = '{{ tags }}',
identity = '{{ identity }}',
plan = '{{ plan }}'
WHERE
resource_group_name = '{{ resource_group_name }}' --required
AND location = '{{ location }}' --required
AND name = '{{ name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
plan,
properties,
systemData,
tags,
type,
zones;

DELETE examples

Deletes LaunchBulkInstancesOperations.

DELETE FROM azure.compute_bulk_actions.bulk_actions
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND location = '{{ location }}' --required
AND name = '{{ name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND deleteInstances = '{{ deleteInstances }}'
;

Lifecycle Methods

List VirtualMachine resources of a LaunchBulkInstancesOperation.

EXEC azure.compute_bulk_actions.bulk_actions.list_virtual_machines 
@resource_group_name='{{ resource_group_name }}' --required,
@location='{{ location }}' --required,
@name='{{ name }}' --required,
@subscription_id='{{ subscription_id }}' --required,
@$filter='{{ $filter }}',
@$skiptoken='{{ $skiptoken }}'
;