1. Packages
  2. Azure Native
  3. API Docs
  4. azurestackhci
  5. getClusterJob
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.16.0
published on Friday, Mar 20, 2026 by Pulumi
azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.16.0
published on Friday, Mar 20, 2026 by Pulumi

    Get a ClusterJob

    Uses Azure REST API version 2026-03-01-preview.

    Other available API versions: 2026-02-15-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native azurestackhci [ApiVersion]. See the version guide for details.

    Using getClusterJob

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getClusterJob(args: GetClusterJobArgs, opts?: InvokeOptions): Promise<GetClusterJobResult>
    function getClusterJobOutput(args: GetClusterJobOutputArgs, opts?: InvokeOptions): Output<GetClusterJobResult>
    def get_cluster_job(cluster_name: Optional[str] = None,
                        jobs_name: Optional[str] = None,
                        resource_group_name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetClusterJobResult
    def get_cluster_job_output(cluster_name: Optional[pulumi.Input[str]] = None,
                        jobs_name: Optional[pulumi.Input[str]] = None,
                        resource_group_name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetClusterJobResult]
    func LookupClusterJob(ctx *Context, args *LookupClusterJobArgs, opts ...InvokeOption) (*LookupClusterJobResult, error)
    func LookupClusterJobOutput(ctx *Context, args *LookupClusterJobOutputArgs, opts ...InvokeOption) LookupClusterJobResultOutput

    > Note: This function is named LookupClusterJob in the Go SDK.

    public static class GetClusterJob 
    {
        public static Task<GetClusterJobResult> InvokeAsync(GetClusterJobArgs args, InvokeOptions? opts = null)
        public static Output<GetClusterJobResult> Invoke(GetClusterJobInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetClusterJobResult> getClusterJob(GetClusterJobArgs args, InvokeOptions options)
    public static Output<GetClusterJobResult> getClusterJob(GetClusterJobArgs args, InvokeOptions options)
    
    fn::invoke:
      function: azure-native:azurestackhci:getClusterJob
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ClusterName string
    The name of the cluster.
    JobsName string
    Name of ClusterJob
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ClusterName string
    The name of the cluster.
    JobsName string
    Name of ClusterJob
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    clusterName String
    The name of the cluster.
    jobsName String
    Name of ClusterJob
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    clusterName string
    The name of the cluster.
    jobsName string
    Name of ClusterJob
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    cluster_name str
    The name of the cluster.
    jobs_name str
    Name of ClusterJob
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    clusterName String
    The name of the cluster.
    jobsName String
    Name of ClusterJob
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getClusterJob Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    Properties Pulumi.AzureNative.AzureStackHCI.Outputs.HciConfigureCvmJobPropertiesResponse | Pulumi.AzureNative.AzureStackHCI.Outputs.HciConfigureSdnIntegrationJobPropertiesResponse
    The resource-specific properties for this resource.
    SystemData Pulumi.AzureNative.AzureStackHCI.Outputs.SystemDataResponse
    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"
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    Properties HciConfigureCvmJobPropertiesResponse | HciConfigureSdnIntegrationJobPropertiesResponse
    The resource-specific properties for this resource.
    SystemData SystemDataResponse
    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"
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    properties HciConfigureCvmJobPropertiesResponse | HciConfigureSdnIntegrationJobPropertiesResponse
    The resource-specific properties for this resource.
    systemData SystemDataResponse
    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"
    azureApiVersion string
    The Azure API version of the resource.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name string
    The name of the resource
    properties HciConfigureCvmJobPropertiesResponse | HciConfigureSdnIntegrationJobPropertiesResponse
    The resource-specific properties for this resource.
    systemData SystemDataResponse
    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"
    azure_api_version str
    The Azure API version of the resource.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name str
    The name of the resource
    properties HciConfigureCvmJobPropertiesResponse | HciConfigureSdnIntegrationJobPropertiesResponse
    The resource-specific properties for this resource.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    properties Property Map | Property Map
    The resource-specific properties for this resource.
    systemData Property Map
    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"

    Supporting Types

    DeploymentStepResponse

    Description string
    Description of step.
    EndTimeUtc string
    End time of step.
    Exception List<string>
    List of exceptions in AzureStackHCI Cluster Deployment.
    FullStepIndex string
    FullStepIndex of step.
    Name string
    Name of step.
    StartTimeUtc string
    Start time of step.
    Status string
    Status of step. Allowed values are 'Error', 'Success', 'InProgress'
    Steps List<Pulumi.AzureNative.AzureStackHCI.Inputs.DeploymentStepResponse>
    List of nested steps of AzureStackHCI Cluster Deployment.
    Description string
    Description of step.
    EndTimeUtc string
    End time of step.
    Exception []string
    List of exceptions in AzureStackHCI Cluster Deployment.
    FullStepIndex string
    FullStepIndex of step.
    Name string
    Name of step.
    StartTimeUtc string
    Start time of step.
    Status string
    Status of step. Allowed values are 'Error', 'Success', 'InProgress'
    Steps []DeploymentStepResponse
    List of nested steps of AzureStackHCI Cluster Deployment.
    description String
    Description of step.
    endTimeUtc String
    End time of step.
    exception List<String>
    List of exceptions in AzureStackHCI Cluster Deployment.
    fullStepIndex String
    FullStepIndex of step.
    name String
    Name of step.
    startTimeUtc String
    Start time of step.
    status String
    Status of step. Allowed values are 'Error', 'Success', 'InProgress'
    steps List<DeploymentStepResponse>
    List of nested steps of AzureStackHCI Cluster Deployment.
    description string
    Description of step.
    endTimeUtc string
    End time of step.
    exception string[]
    List of exceptions in AzureStackHCI Cluster Deployment.
    fullStepIndex string
    FullStepIndex of step.
    name string
    Name of step.
    startTimeUtc string
    Start time of step.
    status string
    Status of step. Allowed values are 'Error', 'Success', 'InProgress'
    steps DeploymentStepResponse[]
    List of nested steps of AzureStackHCI Cluster Deployment.
    description str
    Description of step.
    end_time_utc str
    End time of step.
    exception Sequence[str]
    List of exceptions in AzureStackHCI Cluster Deployment.
    full_step_index str
    FullStepIndex of step.
    name str
    Name of step.
    start_time_utc str
    Start time of step.
    status str
    Status of step. Allowed values are 'Error', 'Success', 'InProgress'
    steps Sequence[DeploymentStepResponse]
    List of nested steps of AzureStackHCI Cluster Deployment.
    description String
    Description of step.
    endTimeUtc String
    End time of step.
    exception List<String>
    List of exceptions in AzureStackHCI Cluster Deployment.
    fullStepIndex String
    FullStepIndex of step.
    name String
    Name of step.
    startTimeUtc String
    Start time of step.
    status String
    Status of step. Allowed values are 'Error', 'Success', 'InProgress'
    steps List<Property Map>
    List of nested steps of AzureStackHCI Cluster Deployment.

    EceActionStatusResponse

    Status string
    Status of ECE action AzureStackHCI Cluster Deployment.
    Steps List<Pulumi.AzureNative.AzureStackHCI.Inputs.DeploymentStepResponse>
    List of steps of AzureStackHCI Cluster Deployment.
    Status string
    Status of ECE action AzureStackHCI Cluster Deployment.
    Steps []DeploymentStepResponse
    List of steps of AzureStackHCI Cluster Deployment.
    status String
    Status of ECE action AzureStackHCI Cluster Deployment.
    steps List<DeploymentStepResponse>
    List of steps of AzureStackHCI Cluster Deployment.
    status string
    Status of ECE action AzureStackHCI Cluster Deployment.
    steps DeploymentStepResponse[]
    List of steps of AzureStackHCI Cluster Deployment.
    status str
    Status of ECE action AzureStackHCI Cluster Deployment.
    steps Sequence[DeploymentStepResponse]
    List of steps of AzureStackHCI Cluster Deployment.
    status String
    Status of ECE action AzureStackHCI Cluster Deployment.
    steps List<Property Map>
    List of steps of AzureStackHCI Cluster Deployment.

    HciConfigureCvmJobPropertiesResponse

    ConfidentialVmIntent string
    Defines the customer's intent for updating confidential VM properties
    EndTimeUtc string
    The UTC date and time at which the job completed.
    JobId string
    Unique, immutable job id.
    ProvisioningState string
    Job provisioning state
    ReportedProperties Pulumi.AzureNative.AzureStackHCI.Inputs.JobReportedPropertiesResponse
    Reported properties for job
    StartTimeUtc string
    The UTC date and time at which the job started.
    Status string
    Status of Cluster job.
    DeploymentMode string
    Deployment mode to trigger job.
    ConfidentialVmIntent string
    Defines the customer's intent for updating confidential VM properties
    EndTimeUtc string
    The UTC date and time at which the job completed.
    JobId string
    Unique, immutable job id.
    ProvisioningState string
    Job provisioning state
    ReportedProperties JobReportedPropertiesResponse
    Reported properties for job
    StartTimeUtc string
    The UTC date and time at which the job started.
    Status string
    Status of Cluster job.
    DeploymentMode string
    Deployment mode to trigger job.
    confidentialVmIntent String
    Defines the customer's intent for updating confidential VM properties
    endTimeUtc String
    The UTC date and time at which the job completed.
    jobId String
    Unique, immutable job id.
    provisioningState String
    Job provisioning state
    reportedProperties JobReportedPropertiesResponse
    Reported properties for job
    startTimeUtc String
    The UTC date and time at which the job started.
    status String
    Status of Cluster job.
    deploymentMode String
    Deployment mode to trigger job.
    confidentialVmIntent string
    Defines the customer's intent for updating confidential VM properties
    endTimeUtc string
    The UTC date and time at which the job completed.
    jobId string
    Unique, immutable job id.
    provisioningState string
    Job provisioning state
    reportedProperties JobReportedPropertiesResponse
    Reported properties for job
    startTimeUtc string
    The UTC date and time at which the job started.
    status string
    Status of Cluster job.
    deploymentMode string
    Deployment mode to trigger job.
    confidential_vm_intent str
    Defines the customer's intent for updating confidential VM properties
    end_time_utc str
    The UTC date and time at which the job completed.
    job_id str
    Unique, immutable job id.
    provisioning_state str
    Job provisioning state
    reported_properties JobReportedPropertiesResponse
    Reported properties for job
    start_time_utc str
    The UTC date and time at which the job started.
    status str
    Status of Cluster job.
    deployment_mode str
    Deployment mode to trigger job.
    confidentialVmIntent String
    Defines the customer's intent for updating confidential VM properties
    endTimeUtc String
    The UTC date and time at which the job completed.
    jobId String
    Unique, immutable job id.
    provisioningState String
    Job provisioning state
    reportedProperties Property Map
    Reported properties for job
    startTimeUtc String
    The UTC date and time at which the job started.
    status String
    Status of Cluster job.
    deploymentMode String
    Deployment mode to trigger job.

    HciConfigureSdnIntegrationJobPropertiesResponse

    EndTimeUtc string
    The UTC date and time at which the job completed.
    JobId string
    Unique, immutable job id.
    ProvisioningState string
    Job provisioning state
    ReportedProperties Pulumi.AzureNative.AzureStackHCI.Inputs.JobReportedPropertiesResponse
    Reported properties for job
    SdnIntegrationIntent string
    Defines the customer's intent for configuring SDN integration
    StartTimeUtc string
    The UTC date and time at which the job started.
    Status string
    Status of Cluster job.
    DeploymentMode string
    Deployment mode to trigger job.
    SdnPrefix string
    A string identifier used to construct the Network Controller (NC) REST resource name. This prefix helps group and distinguish SDN-managed network components and must follow specific formatting rules.
    EndTimeUtc string
    The UTC date and time at which the job completed.
    JobId string
    Unique, immutable job id.
    ProvisioningState string
    Job provisioning state
    ReportedProperties JobReportedPropertiesResponse
    Reported properties for job
    SdnIntegrationIntent string
    Defines the customer's intent for configuring SDN integration
    StartTimeUtc string
    The UTC date and time at which the job started.
    Status string
    Status of Cluster job.
    DeploymentMode string
    Deployment mode to trigger job.
    SdnPrefix string
    A string identifier used to construct the Network Controller (NC) REST resource name. This prefix helps group and distinguish SDN-managed network components and must follow specific formatting rules.
    endTimeUtc String
    The UTC date and time at which the job completed.
    jobId String
    Unique, immutable job id.
    provisioningState String
    Job provisioning state
    reportedProperties JobReportedPropertiesResponse
    Reported properties for job
    sdnIntegrationIntent String
    Defines the customer's intent for configuring SDN integration
    startTimeUtc String
    The UTC date and time at which the job started.
    status String
    Status of Cluster job.
    deploymentMode String
    Deployment mode to trigger job.
    sdnPrefix String
    A string identifier used to construct the Network Controller (NC) REST resource name. This prefix helps group and distinguish SDN-managed network components and must follow specific formatting rules.
    endTimeUtc string
    The UTC date and time at which the job completed.
    jobId string
    Unique, immutable job id.
    provisioningState string
    Job provisioning state
    reportedProperties JobReportedPropertiesResponse
    Reported properties for job
    sdnIntegrationIntent string
    Defines the customer's intent for configuring SDN integration
    startTimeUtc string
    The UTC date and time at which the job started.
    status string
    Status of Cluster job.
    deploymentMode string
    Deployment mode to trigger job.
    sdnPrefix string
    A string identifier used to construct the Network Controller (NC) REST resource name. This prefix helps group and distinguish SDN-managed network components and must follow specific formatting rules.
    end_time_utc str
    The UTC date and time at which the job completed.
    job_id str
    Unique, immutable job id.
    provisioning_state str
    Job provisioning state
    reported_properties JobReportedPropertiesResponse
    Reported properties for job
    sdn_integration_intent str
    Defines the customer's intent for configuring SDN integration
    start_time_utc str
    The UTC date and time at which the job started.
    status str
    Status of Cluster job.
    deployment_mode str
    Deployment mode to trigger job.
    sdn_prefix str
    A string identifier used to construct the Network Controller (NC) REST resource name. This prefix helps group and distinguish SDN-managed network components and must follow specific formatting rules.
    endTimeUtc String
    The UTC date and time at which the job completed.
    jobId String
    Unique, immutable job id.
    provisioningState String
    Job provisioning state
    reportedProperties Property Map
    Reported properties for job
    sdnIntegrationIntent String
    Defines the customer's intent for configuring SDN integration
    startTimeUtc String
    The UTC date and time at which the job started.
    status String
    Status of Cluster job.
    deploymentMode String
    Deployment mode to trigger job.
    sdnPrefix String
    A string identifier used to construct the Network Controller (NC) REST resource name. This prefix helps group and distinguish SDN-managed network components and must follow specific formatting rules.

    JobReportedPropertiesResponse

    DeploymentStatus EceActionStatusResponse
    Deployment status of job.
    PercentComplete int
    The percentage of the job that is complete.
    ValidationStatus EceActionStatusResponse
    Validation status of job.
    deploymentStatus EceActionStatusResponse
    Deployment status of job.
    percentComplete Integer
    The percentage of the job that is complete.
    validationStatus EceActionStatusResponse
    Validation status of job.
    deploymentStatus EceActionStatusResponse
    Deployment status of job.
    percentComplete number
    The percentage of the job that is complete.
    validationStatus EceActionStatusResponse
    Validation status of job.
    deployment_status EceActionStatusResponse
    Deployment status of job.
    percent_complete int
    The percentage of the job that is complete.
    validation_status EceActionStatusResponse
    Validation status of job.
    deploymentStatus Property Map
    Deployment status of job.
    percentComplete Number
    The percentage of the job that is complete.
    validationStatus Property Map
    Validation status of job.

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Viewing docs for Azure Native v3.16.0
    published on Friday, Mar 20, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.