1. Packages
  2. Azure Classic
  3. API Docs
  4. automation
  5. HybridRunbookWorkerGroup

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi

azure.automation.HybridRunbookWorkerGroup

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi

    Manages a Automation Hybrid Runbook Worker Group.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = new azure.core.ResourceGroup("example", {
        name: "example-resources",
        location: "West Europe",
    });
    const exampleAccount = new azure.automation.Account("example", {
        name: "example-account",
        location: example.location,
        resourceGroupName: example.name,
        skuName: "Basic",
    });
    const exampleHybridRunbookWorkerGroup = new azure.automation.HybridRunbookWorkerGroup("example", {
        name: "example",
        resourceGroupName: example.name,
        automationAccountName: exampleAccount.name,
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.ResourceGroup("example",
        name="example-resources",
        location="West Europe")
    example_account = azure.automation.Account("example",
        name="example-account",
        location=example.location,
        resource_group_name=example.name,
        sku_name="Basic")
    example_hybrid_runbook_worker_group = azure.automation.HybridRunbookWorkerGroup("example",
        name="example",
        resource_group_name=example.name,
        automation_account_name=example_account.name)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/automation"
    	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("example-resources"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleAccount, err := automation.NewAccount(ctx, "example", &automation.AccountArgs{
    			Name:              pulumi.String("example-account"),
    			Location:          example.Location,
    			ResourceGroupName: example.Name,
    			SkuName:           pulumi.String("Basic"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = automation.NewHybridRunbookWorkerGroup(ctx, "example", &automation.HybridRunbookWorkerGroupArgs{
    			Name:                  pulumi.String("example"),
    			ResourceGroupName:     example.Name,
    			AutomationAccountName: exampleAccount.Name,
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Azure.Core.ResourceGroup("example", new()
        {
            Name = "example-resources",
            Location = "West Europe",
        });
    
        var exampleAccount = new Azure.Automation.Account("example", new()
        {
            Name = "example-account",
            Location = example.Location,
            ResourceGroupName = example.Name,
            SkuName = "Basic",
        });
    
        var exampleHybridRunbookWorkerGroup = new Azure.Automation.HybridRunbookWorkerGroup("example", new()
        {
            Name = "example",
            ResourceGroupName = example.Name,
            AutomationAccountName = exampleAccount.Name,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.core.ResourceGroup;
    import com.pulumi.azure.core.ResourceGroupArgs;
    import com.pulumi.azure.automation.Account;
    import com.pulumi.azure.automation.AccountArgs;
    import com.pulumi.azure.automation.HybridRunbookWorkerGroup;
    import com.pulumi.azure.automation.HybridRunbookWorkerGroupArgs;
    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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
                .name("example-resources")
                .location("West Europe")
                .build());
    
            var exampleAccount = new Account("exampleAccount", AccountArgs.builder()
                .name("example-account")
                .location(example.location())
                .resourceGroupName(example.name())
                .skuName("Basic")
                .build());
    
            var exampleHybridRunbookWorkerGroup = new HybridRunbookWorkerGroup("exampleHybridRunbookWorkerGroup", HybridRunbookWorkerGroupArgs.builder()
                .name("example")
                .resourceGroupName(example.name())
                .automationAccountName(exampleAccount.name())
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example-resources
          location: West Europe
      exampleAccount:
        type: azure:automation:Account
        name: example
        properties:
          name: example-account
          location: ${example.location}
          resourceGroupName: ${example.name}
          skuName: Basic
      exampleHybridRunbookWorkerGroup:
        type: azure:automation:HybridRunbookWorkerGroup
        name: example
        properties:
          name: example
          resourceGroupName: ${example.name}
          automationAccountName: ${exampleAccount.name}
    

    Create HybridRunbookWorkerGroup Resource

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

    Constructor syntax

    new HybridRunbookWorkerGroup(name: string, args: HybridRunbookWorkerGroupArgs, opts?: CustomResourceOptions);
    @overload
    def HybridRunbookWorkerGroup(resource_name: str,
                                 args: HybridRunbookWorkerGroupArgs,
                                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def HybridRunbookWorkerGroup(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 automation_account_name: Optional[str] = None,
                                 resource_group_name: Optional[str] = None,
                                 credential_name: Optional[str] = None,
                                 name: Optional[str] = None)
    func NewHybridRunbookWorkerGroup(ctx *Context, name string, args HybridRunbookWorkerGroupArgs, opts ...ResourceOption) (*HybridRunbookWorkerGroup, error)
    public HybridRunbookWorkerGroup(string name, HybridRunbookWorkerGroupArgs args, CustomResourceOptions? opts = null)
    public HybridRunbookWorkerGroup(String name, HybridRunbookWorkerGroupArgs args)
    public HybridRunbookWorkerGroup(String name, HybridRunbookWorkerGroupArgs args, CustomResourceOptions options)
    
    type: azure:automation:HybridRunbookWorkerGroup
    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 HybridRunbookWorkerGroupArgs
    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 HybridRunbookWorkerGroupArgs
    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 HybridRunbookWorkerGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args HybridRunbookWorkerGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args HybridRunbookWorkerGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

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

    var hybridRunbookWorkerGroupResource = new Azure.Automation.HybridRunbookWorkerGroup("hybridRunbookWorkerGroupResource", new()
    {
        AutomationAccountName = "string",
        ResourceGroupName = "string",
        CredentialName = "string",
        Name = "string",
    });
    
    example, err := automation.NewHybridRunbookWorkerGroup(ctx, "hybridRunbookWorkerGroupResource", &automation.HybridRunbookWorkerGroupArgs{
    	AutomationAccountName: pulumi.String("string"),
    	ResourceGroupName:     pulumi.String("string"),
    	CredentialName:        pulumi.String("string"),
    	Name:                  pulumi.String("string"),
    })
    
    var hybridRunbookWorkerGroupResource = new HybridRunbookWorkerGroup("hybridRunbookWorkerGroupResource", HybridRunbookWorkerGroupArgs.builder()
        .automationAccountName("string")
        .resourceGroupName("string")
        .credentialName("string")
        .name("string")
        .build());
    
    hybrid_runbook_worker_group_resource = azure.automation.HybridRunbookWorkerGroup("hybridRunbookWorkerGroupResource",
        automation_account_name="string",
        resource_group_name="string",
        credential_name="string",
        name="string")
    
    const hybridRunbookWorkerGroupResource = new azure.automation.HybridRunbookWorkerGroup("hybridRunbookWorkerGroupResource", {
        automationAccountName: "string",
        resourceGroupName: "string",
        credentialName: "string",
        name: "string",
    });
    
    type: azure:automation:HybridRunbookWorkerGroup
    properties:
        automationAccountName: string
        credentialName: string
        name: string
        resourceGroupName: string
    

    HybridRunbookWorkerGroup Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The HybridRunbookWorkerGroup resource accepts the following input properties:

    AutomationAccountName string
    The name of the Automation Account in which the Runbook Worker Group is created. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the Resource Group where the Automation should exist. Changing this forces a new Automation to be created.
    CredentialName string
    The name of resource type azure.automation.Credential to use for hybrid worker.
    Name string
    The name which should be used for this Automation Account Runbook Worker Group. Changing this forces a new resource to be created.
    AutomationAccountName string
    The name of the Automation Account in which the Runbook Worker Group is created. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the Resource Group where the Automation should exist. Changing this forces a new Automation to be created.
    CredentialName string
    The name of resource type azure.automation.Credential to use for hybrid worker.
    Name string
    The name which should be used for this Automation Account Runbook Worker Group. Changing this forces a new resource to be created.
    automationAccountName String
    The name of the Automation Account in which the Runbook Worker Group is created. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the Resource Group where the Automation should exist. Changing this forces a new Automation to be created.
    credentialName String
    The name of resource type azure.automation.Credential to use for hybrid worker.
    name String
    The name which should be used for this Automation Account Runbook Worker Group. Changing this forces a new resource to be created.
    automationAccountName string
    The name of the Automation Account in which the Runbook Worker Group is created. Changing this forces a new resource to be created.
    resourceGroupName string
    The name of the Resource Group where the Automation should exist. Changing this forces a new Automation to be created.
    credentialName string
    The name of resource type azure.automation.Credential to use for hybrid worker.
    name string
    The name which should be used for this Automation Account Runbook Worker Group. Changing this forces a new resource to be created.
    automation_account_name str
    The name of the Automation Account in which the Runbook Worker Group is created. Changing this forces a new resource to be created.
    resource_group_name str
    The name of the Resource Group where the Automation should exist. Changing this forces a new Automation to be created.
    credential_name str
    The name of resource type azure.automation.Credential to use for hybrid worker.
    name str
    The name which should be used for this Automation Account Runbook Worker Group. Changing this forces a new resource to be created.
    automationAccountName String
    The name of the Automation Account in which the Runbook Worker Group is created. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the Resource Group where the Automation should exist. Changing this forces a new Automation to be created.
    credentialName String
    The name of resource type azure.automation.Credential to use for hybrid worker.
    name String
    The name which should be used for this Automation Account Runbook Worker Group. Changing this forces a new resource to be created.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing HybridRunbookWorkerGroup Resource

    Get an existing HybridRunbookWorkerGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: HybridRunbookWorkerGroupState, opts?: CustomResourceOptions): HybridRunbookWorkerGroup
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            automation_account_name: Optional[str] = None,
            credential_name: Optional[str] = None,
            name: Optional[str] = None,
            resource_group_name: Optional[str] = None) -> HybridRunbookWorkerGroup
    func GetHybridRunbookWorkerGroup(ctx *Context, name string, id IDInput, state *HybridRunbookWorkerGroupState, opts ...ResourceOption) (*HybridRunbookWorkerGroup, error)
    public static HybridRunbookWorkerGroup Get(string name, Input<string> id, HybridRunbookWorkerGroupState? state, CustomResourceOptions? opts = null)
    public static HybridRunbookWorkerGroup get(String name, Output<String> id, HybridRunbookWorkerGroupState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AutomationAccountName string
    The name of the Automation Account in which the Runbook Worker Group is created. Changing this forces a new resource to be created.
    CredentialName string
    The name of resource type azure.automation.Credential to use for hybrid worker.
    Name string
    The name which should be used for this Automation Account Runbook Worker Group. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the Resource Group where the Automation should exist. Changing this forces a new Automation to be created.
    AutomationAccountName string
    The name of the Automation Account in which the Runbook Worker Group is created. Changing this forces a new resource to be created.
    CredentialName string
    The name of resource type azure.automation.Credential to use for hybrid worker.
    Name string
    The name which should be used for this Automation Account Runbook Worker Group. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the Resource Group where the Automation should exist. Changing this forces a new Automation to be created.
    automationAccountName String
    The name of the Automation Account in which the Runbook Worker Group is created. Changing this forces a new resource to be created.
    credentialName String
    The name of resource type azure.automation.Credential to use for hybrid worker.
    name String
    The name which should be used for this Automation Account Runbook Worker Group. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the Resource Group where the Automation should exist. Changing this forces a new Automation to be created.
    automationAccountName string
    The name of the Automation Account in which the Runbook Worker Group is created. Changing this forces a new resource to be created.
    credentialName string
    The name of resource type azure.automation.Credential to use for hybrid worker.
    name string
    The name which should be used for this Automation Account Runbook Worker Group. Changing this forces a new resource to be created.
    resourceGroupName string
    The name of the Resource Group where the Automation should exist. Changing this forces a new Automation to be created.
    automation_account_name str
    The name of the Automation Account in which the Runbook Worker Group is created. Changing this forces a new resource to be created.
    credential_name str
    The name of resource type azure.automation.Credential to use for hybrid worker.
    name str
    The name which should be used for this Automation Account Runbook Worker Group. Changing this forces a new resource to be created.
    resource_group_name str
    The name of the Resource Group where the Automation should exist. Changing this forces a new Automation to be created.
    automationAccountName String
    The name of the Automation Account in which the Runbook Worker Group is created. Changing this forces a new resource to be created.
    credentialName String
    The name of resource type azure.automation.Credential to use for hybrid worker.
    name String
    The name which should be used for this Automation Account Runbook Worker Group. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the Resource Group where the Automation should exist. Changing this forces a new Automation to be created.

    Import

    Automations can be imported using the resource id, e.g.

    $ pulumi import azure:automation/hybridRunbookWorkerGroup:HybridRunbookWorkerGroup example /subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/group1/providers/Microsoft.Automation/automationAccounts/account1/hybridRunbookWorkerGroups/grp1
    

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

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi