1. Packages
  2. Azure Native
  3. API Docs
  4. automation
  5. HybridRunbookWorker
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.44.1 published on Thursday, Jun 6, 2024 by Pulumi

azure-native.automation.HybridRunbookWorker

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.44.1 published on Thursday, Jun 6, 2024 by Pulumi

    Definition of hybrid runbook worker. Azure REST API version: 2022-08-08. Prior API version in Azure Native 1.x: 2021-06-22.

    Other available API versions: 2023-05-15-preview, 2023-11-01.

    Example Usage

    Create a V2 hybrid runbook worker

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var hybridRunbookWorker = new AzureNative.Automation.HybridRunbookWorker("hybridRunbookWorker", new()
        {
            AutomationAccountName = "testaccount",
            HybridRunbookWorkerGroupName = "TestHybridGroup",
            HybridRunbookWorkerId = "c010ad12-ef14-4a2a-aa9e-ef22c4745ddd",
            ResourceGroupName = "rg",
            VmResourceId = "/subscriptions/vmsubid/resourceGroups/vmrg/providers/Microsoft.Compute/virtualMachines/vmname",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure-native-sdk/automation/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := automation.NewHybridRunbookWorker(ctx, "hybridRunbookWorker", &automation.HybridRunbookWorkerArgs{
    			AutomationAccountName:        pulumi.String("testaccount"),
    			HybridRunbookWorkerGroupName: pulumi.String("TestHybridGroup"),
    			HybridRunbookWorkerId:        pulumi.String("c010ad12-ef14-4a2a-aa9e-ef22c4745ddd"),
    			ResourceGroupName:            pulumi.String("rg"),
    			VmResourceId:                 pulumi.String("/subscriptions/vmsubid/resourceGroups/vmrg/providers/Microsoft.Compute/virtualMachines/vmname"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azurenative.automation.HybridRunbookWorker;
    import com.pulumi.azurenative.automation.HybridRunbookWorkerArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var hybridRunbookWorker = new HybridRunbookWorker("hybridRunbookWorker", HybridRunbookWorkerArgs.builder()
                .automationAccountName("testaccount")
                .hybridRunbookWorkerGroupName("TestHybridGroup")
                .hybridRunbookWorkerId("c010ad12-ef14-4a2a-aa9e-ef22c4745ddd")
                .resourceGroupName("rg")
                .vmResourceId("/subscriptions/vmsubid/resourceGroups/vmrg/providers/Microsoft.Compute/virtualMachines/vmname")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    hybrid_runbook_worker = azure_native.automation.HybridRunbookWorker("hybridRunbookWorker",
        automation_account_name="testaccount",
        hybrid_runbook_worker_group_name="TestHybridGroup",
        hybrid_runbook_worker_id="c010ad12-ef14-4a2a-aa9e-ef22c4745ddd",
        resource_group_name="rg",
        vm_resource_id="/subscriptions/vmsubid/resourceGroups/vmrg/providers/Microsoft.Compute/virtualMachines/vmname")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const hybridRunbookWorker = new azure_native.automation.HybridRunbookWorker("hybridRunbookWorker", {
        automationAccountName: "testaccount",
        hybridRunbookWorkerGroupName: "TestHybridGroup",
        hybridRunbookWorkerId: "c010ad12-ef14-4a2a-aa9e-ef22c4745ddd",
        resourceGroupName: "rg",
        vmResourceId: "/subscriptions/vmsubid/resourceGroups/vmrg/providers/Microsoft.Compute/virtualMachines/vmname",
    });
    
    resources:
      hybridRunbookWorker:
        type: azure-native:automation:HybridRunbookWorker
        properties:
          automationAccountName: testaccount
          hybridRunbookWorkerGroupName: TestHybridGroup
          hybridRunbookWorkerId: c010ad12-ef14-4a2a-aa9e-ef22c4745ddd
          resourceGroupName: rg
          vmResourceId: /subscriptions/vmsubid/resourceGroups/vmrg/providers/Microsoft.Compute/virtualMachines/vmname
    

    Create HybridRunbookWorker Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new HybridRunbookWorker(name: string, args: HybridRunbookWorkerArgs, opts?: CustomResourceOptions);
    @overload
    def HybridRunbookWorker(resource_name: str,
                            args: HybridRunbookWorkerArgs,
                            opts: Optional[ResourceOptions] = None)
    
    @overload
    def HybridRunbookWorker(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            automation_account_name: Optional[str] = None,
                            hybrid_runbook_worker_group_name: Optional[str] = None,
                            resource_group_name: Optional[str] = None,
                            hybrid_runbook_worker_id: Optional[str] = None,
                            name: Optional[str] = None,
                            vm_resource_id: Optional[str] = None)
    func NewHybridRunbookWorker(ctx *Context, name string, args HybridRunbookWorkerArgs, opts ...ResourceOption) (*HybridRunbookWorker, error)
    public HybridRunbookWorker(string name, HybridRunbookWorkerArgs args, CustomResourceOptions? opts = null)
    public HybridRunbookWorker(String name, HybridRunbookWorkerArgs args)
    public HybridRunbookWorker(String name, HybridRunbookWorkerArgs args, CustomResourceOptions options)
    
    type: azure-native:automation:HybridRunbookWorker
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args HybridRunbookWorkerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args HybridRunbookWorkerArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args HybridRunbookWorkerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args HybridRunbookWorkerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args HybridRunbookWorkerArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var hybridRunbookWorkerResource = new AzureNative.Automation.HybridRunbookWorker("hybridRunbookWorkerResource", new()
    {
        AutomationAccountName = "string",
        HybridRunbookWorkerGroupName = "string",
        ResourceGroupName = "string",
        HybridRunbookWorkerId = "string",
        Name = "string",
        VmResourceId = "string",
    });
    
    example, err := automation.NewHybridRunbookWorker(ctx, "hybridRunbookWorkerResource", &automation.HybridRunbookWorkerArgs{
    AutomationAccountName: pulumi.String("string"),
    HybridRunbookWorkerGroupName: pulumi.String("string"),
    ResourceGroupName: pulumi.String("string"),
    HybridRunbookWorkerId: pulumi.String("string"),
    Name: pulumi.String("string"),
    VmResourceId: pulumi.String("string"),
    })
    
    var hybridRunbookWorkerResource = new HybridRunbookWorker("hybridRunbookWorkerResource", HybridRunbookWorkerArgs.builder()
        .automationAccountName("string")
        .hybridRunbookWorkerGroupName("string")
        .resourceGroupName("string")
        .hybridRunbookWorkerId("string")
        .name("string")
        .vmResourceId("string")
        .build());
    
    hybrid_runbook_worker_resource = azure_native.automation.HybridRunbookWorker("hybridRunbookWorkerResource",
        automation_account_name="string",
        hybrid_runbook_worker_group_name="string",
        resource_group_name="string",
        hybrid_runbook_worker_id="string",
        name="string",
        vm_resource_id="string")
    
    const hybridRunbookWorkerResource = new azure_native.automation.HybridRunbookWorker("hybridRunbookWorkerResource", {
        automationAccountName: "string",
        hybridRunbookWorkerGroupName: "string",
        resourceGroupName: "string",
        hybridRunbookWorkerId: "string",
        name: "string",
        vmResourceId: "string",
    });
    
    type: azure-native:automation:HybridRunbookWorker
    properties:
        automationAccountName: string
        hybridRunbookWorkerGroupName: string
        hybridRunbookWorkerId: string
        name: string
        resourceGroupName: string
        vmResourceId: string
    

    HybridRunbookWorker Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The HybridRunbookWorker resource accepts the following input properties:

    AutomationAccountName string
    The name of the automation account.
    HybridRunbookWorkerGroupName string
    The hybrid runbook worker group name
    ResourceGroupName string
    Name of an Azure Resource group.
    HybridRunbookWorkerId string
    The hybrid runbook worker id
    Name string
    Gets or sets the name of the resource.
    VmResourceId string
    Azure Resource Manager Id for a virtual machine.
    AutomationAccountName string
    The name of the automation account.
    HybridRunbookWorkerGroupName string
    The hybrid runbook worker group name
    ResourceGroupName string
    Name of an Azure Resource group.
    HybridRunbookWorkerId string
    The hybrid runbook worker id
    Name string
    Gets or sets the name of the resource.
    VmResourceId string
    Azure Resource Manager Id for a virtual machine.
    automationAccountName String
    The name of the automation account.
    hybridRunbookWorkerGroupName String
    The hybrid runbook worker group name
    resourceGroupName String
    Name of an Azure Resource group.
    hybridRunbookWorkerId String
    The hybrid runbook worker id
    name String
    Gets or sets the name of the resource.
    vmResourceId String
    Azure Resource Manager Id for a virtual machine.
    automationAccountName string
    The name of the automation account.
    hybridRunbookWorkerGroupName string
    The hybrid runbook worker group name
    resourceGroupName string
    Name of an Azure Resource group.
    hybridRunbookWorkerId string
    The hybrid runbook worker id
    name string
    Gets or sets the name of the resource.
    vmResourceId string
    Azure Resource Manager Id for a virtual machine.
    automation_account_name str
    The name of the automation account.
    hybrid_runbook_worker_group_name str
    The hybrid runbook worker group name
    resource_group_name str
    Name of an Azure Resource group.
    hybrid_runbook_worker_id str
    The hybrid runbook worker id
    name str
    Gets or sets the name of the resource.
    vm_resource_id str
    Azure Resource Manager Id for a virtual machine.
    automationAccountName String
    The name of the automation account.
    hybridRunbookWorkerGroupName String
    The hybrid runbook worker group name
    resourceGroupName String
    Name of an Azure Resource group.
    hybridRunbookWorkerId String
    The hybrid runbook worker id
    name String
    Gets or sets the name of the resource.
    vmResourceId String
    Azure Resource Manager Id for a virtual machine.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the HybridRunbookWorker resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    SystemData Pulumi.AzureNative.Automation.Outputs.SystemDataResponse
    Resource system metadata.
    Type string
    The type of the resource.
    Ip string
    Gets or sets the assigned machine IP address.
    LastSeenDateTime string
    Last Heartbeat from the Worker
    RegisteredDateTime string
    Gets or sets the registration time of the worker machine.
    WorkerName string
    Name of the HybridWorker.
    WorkerType string
    Type of the HybridWorker.
    Id string
    The provider-assigned unique ID for this managed resource.
    SystemData SystemDataResponse
    Resource system metadata.
    Type string
    The type of the resource.
    Ip string
    Gets or sets the assigned machine IP address.
    LastSeenDateTime string
    Last Heartbeat from the Worker
    RegisteredDateTime string
    Gets or sets the registration time of the worker machine.
    WorkerName string
    Name of the HybridWorker.
    WorkerType string
    Type of the HybridWorker.
    id String
    The provider-assigned unique ID for this managed resource.
    systemData SystemDataResponse
    Resource system metadata.
    type String
    The type of the resource.
    ip String
    Gets or sets the assigned machine IP address.
    lastSeenDateTime String
    Last Heartbeat from the Worker
    registeredDateTime String
    Gets or sets the registration time of the worker machine.
    workerName String
    Name of the HybridWorker.
    workerType String
    Type of the HybridWorker.
    id string
    The provider-assigned unique ID for this managed resource.
    systemData SystemDataResponse
    Resource system metadata.
    type string
    The type of the resource.
    ip string
    Gets or sets the assigned machine IP address.
    lastSeenDateTime string
    Last Heartbeat from the Worker
    registeredDateTime string
    Gets or sets the registration time of the worker machine.
    workerName string
    Name of the HybridWorker.
    workerType string
    Type of the HybridWorker.
    id str
    The provider-assigned unique ID for this managed resource.
    system_data SystemDataResponse
    Resource system metadata.
    type str
    The type of the resource.
    ip str
    Gets or sets the assigned machine IP address.
    last_seen_date_time str
    Last Heartbeat from the Worker
    registered_date_time str
    Gets or sets the registration time of the worker machine.
    worker_name str
    Name of the HybridWorker.
    worker_type str
    Type of the HybridWorker.
    id String
    The provider-assigned unique ID for this managed resource.
    systemData Property Map
    Resource system metadata.
    type String
    The type of the resource.
    ip String
    Gets or sets the assigned machine IP address.
    lastSeenDateTime String
    Last Heartbeat from the Worker
    registeredDateTime String
    Gets or sets the registration time of the worker machine.
    workerName String
    Name of the HybridWorker.
    workerType String
    Type of the HybridWorker.

    Supporting Types

    SystemDataResponse, SystemDataResponseArgs

    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.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:automation:HybridRunbookWorker c010ad12-ef14-4a2a-aa9e-ef22c4745ddd /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/hybridRunbookWorkerGroups/{hybridRunbookWorkerGroupName}/hybridRunbookWorkers/{hybridRunbookWorkerId} 
    

    To learn more about importing existing cloud resources, see Importing resources.

    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 v1 docs if using the v1 version of this package.
    Azure Native v2.44.1 published on Thursday, Jun 6, 2024 by Pulumi