cluster_jobs

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

Overview

Name	cluster_jobs
Type	Resource
Id	azure_stack.azure_stack_hci.cluster_jobs

Fields

The following fields are returned by SELECT queries:

get

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.
deploymentMode	string	Deployment mode to trigger job. Known values are: "Validate" and "Deploy". (Validate, Deploy)
endTimeUtc	string (date-time)	The UTC date and time at which the job completed.
jobId	string	Unique, immutable job id.
jobType	string	Job Type to support polymorphic resource. Required. Known values are: "ConfigureCVM" and "ConfigureSdnIntegration".
provisioningState	string	Job provisioning state. Known values are: "NotSpecified", "Error", "Succeeded", "Failed", "Canceled", "Connected", "Disconnected", "Deleted", "Creating", "Updating", "Deleting", "Moving", "PartiallySucceeded", "PartiallyConnected", "InProgress", "Accepted", "Provisioning", and "DisableInProgress". (NotSpecified, Error, Succeeded, Failed, Canceled, Connected, Disconnected, Deleted, Creating, Updating, Deleting, Moving, PartiallySucceeded, PartiallyConnected, InProgress, Accepted, Provisioning, DisableInProgress)
reportedProperties	object	Reported properties for job.
startTimeUtc	string (date-time)	The UTC date and time at which the job started.
status	string	Status of Cluster job. Known values are: "NotSpecified", "ValidationInProgress", "ValidationSuccess", "ValidationFailed", "DeploymentInProgress", "DeploymentFailed", "DeploymentSuccess", "Succeeded", "Failed", "Canceled", "Paused", and "Scheduled". (NotSpecified, ValidationInProgress, ValidationSuccess, ValidationFailed, DeploymentInProgress, DeploymentFailed, DeploymentSuccess, Succeeded, Failed, Canceled, Paused, Scheduled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

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.
deploymentMode	string	Deployment mode to trigger job. Known values are: "Validate" and "Deploy". (Validate, Deploy)
endTimeUtc	string (date-time)	The UTC date and time at which the job completed.
jobId	string	Unique, immutable job id.
jobType	string	Job Type to support polymorphic resource. Required. Known values are: "ConfigureCVM" and "ConfigureSdnIntegration".
provisioningState	string	Job provisioning state. Known values are: "NotSpecified", "Error", "Succeeded", "Failed", "Canceled", "Connected", "Disconnected", "Deleted", "Creating", "Updating", "Deleting", "Moving", "PartiallySucceeded", "PartiallyConnected", "InProgress", "Accepted", "Provisioning", and "DisableInProgress". (NotSpecified, Error, Succeeded, Failed, Canceled, Connected, Disconnected, Deleted, Creating, Updating, Deleting, Moving, PartiallySucceeded, PartiallyConnected, InProgress, Accepted, Provisioning, DisableInProgress)
reportedProperties	object	Reported properties for job.
startTimeUtc	string (date-time)	The UTC date and time at which the job started.
status	string	Status of Cluster job. Known values are: "NotSpecified", "ValidationInProgress", "ValidationSuccess", "ValidationFailed", "DeploymentInProgress", "DeploymentFailed", "DeploymentSuccess", "Succeeded", "Failed", "Canceled", "Paused", and "Scheduled". (NotSpecified, ValidationInProgress, ValidationSuccess, ValidationFailed, DeploymentInProgress, DeploymentFailed, DeploymentSuccess, Succeeded, Failed, Canceled, Paused, Scheduled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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	resource_group_name, cluster_name, jobs_name, subscription_id		Get a ClusterJob.
list	select	resource_group_name, cluster_name, subscription_id		List ClusterJob resources by Clusters.
create_or_update	insert	resource_group_name, cluster_name, jobs_name, subscription_id		Create a ClusterJob.
create_or_update	replace	resource_group_name, cluster_name, jobs_name, subscription_id		Create a ClusterJob.
delete	delete	resource_group_name, cluster_name, jobs_name, subscription_id		Delete a ClusterJob.

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
cluster_name	string	The name of the cluster. Required.
jobs_name	string	Name of ClusterJob. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get a ClusterJob.

SELECT
id,
name,
deploymentMode,
endTimeUtc,
jobId,
jobType,
provisioningState,
reportedProperties,
startTimeUtc,
status,
systemData,
type
FROM azure_stack.azure_stack_hci.cluster_jobs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND jobs_name = '{{ jobs_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List ClusterJob resources by Clusters.

SELECT
id,
name,
deploymentMode,
endTimeUtc,
jobId,
jobType,
provisioningState,
reportedProperties,
startTimeUtc,
status,
systemData,
type
FROM azure_stack.azure_stack_hci.cluster_jobs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a ClusterJob.

INSERT INTO azure_stack.azure_stack_hci.cluster_jobs (
properties,
resource_group_name,
cluster_name,
jobs_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ cluster_name }}',
'{{ jobs_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: cluster_jobs
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the cluster_jobs resource.
  - name: cluster_name
    value: "{{ cluster_name }}"
    description: Required parameter for the cluster_jobs resource.
  - name: jobs_name
    value: "{{ jobs_name }}"
    description: Required parameter for the cluster_jobs resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the cluster_jobs resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      jobType: "{{ jobType }}"
      deploymentMode: "{{ deploymentMode }}"
      provisioningState: "{{ provisioningState }}"
      jobId: "{{ jobId }}"
      startTimeUtc: "{{ startTimeUtc }}"
      endTimeUtc: "{{ endTimeUtc }}"
      status: "{{ status }}"
      reportedProperties:
        percentComplete: {{ percentComplete }}
        validationStatus:
          status: "{{ status }}"
          steps:
            - name: "{{ name }}"
              description: "{{ description }}"
              fullStepIndex: "{{ fullStepIndex }}"
              startTimeUtc: "{{ startTimeUtc }}"
              endTimeUtc: "{{ endTimeUtc }}"
              status: "{{ status }}"
              steps: "{{ steps }}"
              exception: "{{ exception }}"
        deploymentStatus:
          status: "{{ status }}"
          steps:
            - name: "{{ name }}"
              description: "{{ description }}"
              fullStepIndex: "{{ fullStepIndex }}"
              startTimeUtc: "{{ startTimeUtc }}"
              endTimeUtc: "{{ endTimeUtc }}"
              status: "{{ status }}"
              steps: "{{ steps }}"
              exception: "{{ exception }}"

REPLACE examples

create_or_update

Create a ClusterJob.

REPLACE azure_stack.azure_stack_hci.cluster_jobs
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND jobs_name = '{{ jobs_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete a ClusterJob.

DELETE FROM azure_stack.azure_stack_hci.cluster_jobs
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND jobs_name = '{{ jobs_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;