1. Packages
  2. Azure Native
  3. API Docs
  4. automation
  5. Module
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.46.0 published on Friday, Jun 21, 2024 by Pulumi

azure-native.automation.Module

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.46.0 published on Friday, Jun 21, 2024 by Pulumi

    Definition of the module type. Azure REST API version: 2022-08-08. Prior API version in Azure Native 1.x: 2019-06-01.

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

    Example Usage

    Create or update a module

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var module = new AzureNative.Automation.Module("module", new()
        {
            AutomationAccountName = "myAutomationAccount33",
            ContentLink = new AzureNative.Automation.Inputs.ContentLinkArgs
            {
                ContentHash = new AzureNative.Automation.Inputs.ContentHashArgs
                {
                    Algorithm = "sha265",
                    Value = "07E108A962B81DD9C9BAA89BB47C0F6EE52B29E83758B07795E408D258B2B87A",
                },
                Uri = "https://teststorage.blob.core.windows.net/dsccomposite/OmsCompositeResources.zip",
                Version = "1.0.0.0",
            },
            ModuleName = "OmsCompositeResources",
            ResourceGroupName = "rg",
        });
    
    });
    
    package main
    
    import (
    	automation "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.NewModule(ctx, "module", &automation.ModuleArgs{
    			AutomationAccountName: pulumi.String("myAutomationAccount33"),
    			ContentLink: &automation.ContentLinkArgs{
    				ContentHash: &automation.ContentHashArgs{
    					Algorithm: pulumi.String("sha265"),
    					Value:     pulumi.String("07E108A962B81DD9C9BAA89BB47C0F6EE52B29E83758B07795E408D258B2B87A"),
    				},
    				Uri:     pulumi.String("https://teststorage.blob.core.windows.net/dsccomposite/OmsCompositeResources.zip"),
    				Version: pulumi.String("1.0.0.0"),
    			},
    			ModuleName:        pulumi.String("OmsCompositeResources"),
    			ResourceGroupName: pulumi.String("rg"),
    		})
    		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.Module;
    import com.pulumi.azurenative.automation.ModuleArgs;
    import com.pulumi.azurenative.automation.inputs.ContentLinkArgs;
    import com.pulumi.azurenative.automation.inputs.ContentHashArgs;
    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 module = new Module("module", ModuleArgs.builder()
                .automationAccountName("myAutomationAccount33")
                .contentLink(ContentLinkArgs.builder()
                    .contentHash(ContentHashArgs.builder()
                        .algorithm("sha265")
                        .value("07E108A962B81DD9C9BAA89BB47C0F6EE52B29E83758B07795E408D258B2B87A")
                        .build())
                    .uri("https://teststorage.blob.core.windows.net/dsccomposite/OmsCompositeResources.zip")
                    .version("1.0.0.0")
                    .build())
                .moduleName("OmsCompositeResources")
                .resourceGroupName("rg")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    module = azure_native.automation.Module("module",
        automation_account_name="myAutomationAccount33",
        content_link=azure_native.automation.ContentLinkArgs(
            content_hash=azure_native.automation.ContentHashArgs(
                algorithm="sha265",
                value="07E108A962B81DD9C9BAA89BB47C0F6EE52B29E83758B07795E408D258B2B87A",
            ),
            uri="https://teststorage.blob.core.windows.net/dsccomposite/OmsCompositeResources.zip",
            version="1.0.0.0",
        ),
        module_name="OmsCompositeResources",
        resource_group_name="rg")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const module = new azure_native.automation.Module("module", {
        automationAccountName: "myAutomationAccount33",
        contentLink: {
            contentHash: {
                algorithm: "sha265",
                value: "07E108A962B81DD9C9BAA89BB47C0F6EE52B29E83758B07795E408D258B2B87A",
            },
            uri: "https://teststorage.blob.core.windows.net/dsccomposite/OmsCompositeResources.zip",
            version: "1.0.0.0",
        },
        moduleName: "OmsCompositeResources",
        resourceGroupName: "rg",
    });
    
    resources:
      module:
        type: azure-native:automation:Module
        properties:
          automationAccountName: myAutomationAccount33
          contentLink:
            contentHash:
              algorithm: sha265
              value: 07E108A962B81DD9C9BAA89BB47C0F6EE52B29E83758B07795E408D258B2B87A
            uri: https://teststorage.blob.core.windows.net/dsccomposite/OmsCompositeResources.zip
            version: 1.0.0.0
          moduleName: OmsCompositeResources
          resourceGroupName: rg
    

    Create Module Resource

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

    Constructor syntax

    new Module(name: string, args: ModuleArgs, opts?: CustomResourceOptions);
    @overload
    def Module(resource_name: str,
               args: ModuleArgs,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def Module(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               automation_account_name: Optional[str] = None,
               content_link: Optional[ContentLinkArgs] = None,
               resource_group_name: Optional[str] = None,
               location: Optional[str] = None,
               module_name: Optional[str] = None,
               name: Optional[str] = None,
               tags: Optional[Mapping[str, str]] = None)
    func NewModule(ctx *Context, name string, args ModuleArgs, opts ...ResourceOption) (*Module, error)
    public Module(string name, ModuleArgs args, CustomResourceOptions? opts = null)
    public Module(String name, ModuleArgs args)
    public Module(String name, ModuleArgs args, CustomResourceOptions options)
    
    type: azure-native:automation:Module
    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 ModuleArgs
    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 ModuleArgs
    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 ModuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ModuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ModuleArgs
    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 moduleResource = new AzureNative.Automation.Module("moduleResource", new()
    {
        AutomationAccountName = "string",
        ContentLink = new AzureNative.Automation.Inputs.ContentLinkArgs
        {
            ContentHash = new AzureNative.Automation.Inputs.ContentHashArgs
            {
                Algorithm = "string",
                Value = "string",
            },
            Uri = "string",
            Version = "string",
        },
        ResourceGroupName = "string",
        Location = "string",
        ModuleName = "string",
        Name = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := automation.NewModule(ctx, "moduleResource", &automation.ModuleArgs{
    AutomationAccountName: pulumi.String("string"),
    ContentLink: &automation.ContentLinkArgs{
    ContentHash: &automation.ContentHashArgs{
    Algorithm: pulumi.String("string"),
    Value: pulumi.String("string"),
    },
    Uri: pulumi.String("string"),
    Version: pulumi.String("string"),
    },
    ResourceGroupName: pulumi.String("string"),
    Location: pulumi.String("string"),
    ModuleName: pulumi.String("string"),
    Name: pulumi.String("string"),
    Tags: pulumi.StringMap{
    "string": pulumi.String("string"),
    },
    })
    
    var moduleResource = new Module("moduleResource", ModuleArgs.builder()
        .automationAccountName("string")
        .contentLink(ContentLinkArgs.builder()
            .contentHash(ContentHashArgs.builder()
                .algorithm("string")
                .value("string")
                .build())
            .uri("string")
            .version("string")
            .build())
        .resourceGroupName("string")
        .location("string")
        .moduleName("string")
        .name("string")
        .tags(Map.of("string", "string"))
        .build());
    
    module_resource = azure_native.automation.Module("moduleResource",
        automation_account_name="string",
        content_link=azure_native.automation.ContentLinkArgs(
            content_hash=azure_native.automation.ContentHashArgs(
                algorithm="string",
                value="string",
            ),
            uri="string",
            version="string",
        ),
        resource_group_name="string",
        location="string",
        module_name="string",
        name="string",
        tags={
            "string": "string",
        })
    
    const moduleResource = new azure_native.automation.Module("moduleResource", {
        automationAccountName: "string",
        contentLink: {
            contentHash: {
                algorithm: "string",
                value: "string",
            },
            uri: "string",
            version: "string",
        },
        resourceGroupName: "string",
        location: "string",
        moduleName: "string",
        name: "string",
        tags: {
            string: "string",
        },
    });
    
    type: azure-native:automation:Module
    properties:
        automationAccountName: string
        contentLink:
            contentHash:
                algorithm: string
                value: string
            uri: string
            version: string
        location: string
        moduleName: string
        name: string
        resourceGroupName: string
        tags:
            string: string
    

    Module 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 Module resource accepts the following input properties:

    AutomationAccountName string
    The name of the automation account.
    ContentLink Pulumi.AzureNative.Automation.Inputs.ContentLink
    Gets or sets the module content link.
    ResourceGroupName string
    Name of an Azure Resource group.
    Location string
    Gets or sets the location of the resource.
    ModuleName string
    The name of module.
    Name string
    Gets or sets name of the resource.
    Tags Dictionary<string, string>
    Gets or sets the tags attached to the resource.
    AutomationAccountName string
    The name of the automation account.
    ContentLink ContentLinkArgs
    Gets or sets the module content link.
    ResourceGroupName string
    Name of an Azure Resource group.
    Location string
    Gets or sets the location of the resource.
    ModuleName string
    The name of module.
    Name string
    Gets or sets name of the resource.
    Tags map[string]string
    Gets or sets the tags attached to the resource.
    automationAccountName String
    The name of the automation account.
    contentLink ContentLink
    Gets or sets the module content link.
    resourceGroupName String
    Name of an Azure Resource group.
    location String
    Gets or sets the location of the resource.
    moduleName String
    The name of module.
    name String
    Gets or sets name of the resource.
    tags Map<String,String>
    Gets or sets the tags attached to the resource.
    automationAccountName string
    The name of the automation account.
    contentLink ContentLink
    Gets or sets the module content link.
    resourceGroupName string
    Name of an Azure Resource group.
    location string
    Gets or sets the location of the resource.
    moduleName string
    The name of module.
    name string
    Gets or sets name of the resource.
    tags {[key: string]: string}
    Gets or sets the tags attached to the resource.
    automation_account_name str
    The name of the automation account.
    content_link ContentLinkArgs
    Gets or sets the module content link.
    resource_group_name str
    Name of an Azure Resource group.
    location str
    Gets or sets the location of the resource.
    module_name str
    The name of module.
    name str
    Gets or sets name of the resource.
    tags Mapping[str, str]
    Gets or sets the tags attached to the resource.
    automationAccountName String
    The name of the automation account.
    contentLink Property Map
    Gets or sets the module content link.
    resourceGroupName String
    Name of an Azure Resource group.
    location String
    Gets or sets the location of the resource.
    moduleName String
    The name of module.
    name String
    Gets or sets name of the resource.
    tags Map<String>
    Gets or sets the tags attached to the resource.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Type string
    The type of the resource.
    ActivityCount int
    Gets or sets the activity count of the module.
    CreationTime string
    Gets or sets the creation time.
    Description string
    Gets or sets the description.
    Error Pulumi.AzureNative.Automation.Outputs.ModuleErrorInfoResponse
    Gets or sets the error info of the module.
    Etag string
    Gets or sets the etag of the resource.
    IsComposite bool
    Gets or sets type of module, if its composite or not.
    IsGlobal bool
    Gets or sets the isGlobal flag of the module.
    LastModifiedTime string
    Gets or sets the last modified time.
    ProvisioningState string
    Gets or sets the provisioning state of the module.
    SizeInBytes double
    Gets or sets the size in bytes of the module.
    Version string
    Gets or sets the version of the module.
    Id string
    The provider-assigned unique ID for this managed resource.
    Type string
    The type of the resource.
    ActivityCount int
    Gets or sets the activity count of the module.
    CreationTime string
    Gets or sets the creation time.
    Description string
    Gets or sets the description.
    Error ModuleErrorInfoResponse
    Gets or sets the error info of the module.
    Etag string
    Gets or sets the etag of the resource.
    IsComposite bool
    Gets or sets type of module, if its composite or not.
    IsGlobal bool
    Gets or sets the isGlobal flag of the module.
    LastModifiedTime string
    Gets or sets the last modified time.
    ProvisioningState string
    Gets or sets the provisioning state of the module.
    SizeInBytes float64
    Gets or sets the size in bytes of the module.
    Version string
    Gets or sets the version of the module.
    id String
    The provider-assigned unique ID for this managed resource.
    type String
    The type of the resource.
    activityCount Integer
    Gets or sets the activity count of the module.
    creationTime String
    Gets or sets the creation time.
    description String
    Gets or sets the description.
    error ModuleErrorInfoResponse
    Gets or sets the error info of the module.
    etag String
    Gets or sets the etag of the resource.
    isComposite Boolean
    Gets or sets type of module, if its composite or not.
    isGlobal Boolean
    Gets or sets the isGlobal flag of the module.
    lastModifiedTime String
    Gets or sets the last modified time.
    provisioningState String
    Gets or sets the provisioning state of the module.
    sizeInBytes Double
    Gets or sets the size in bytes of the module.
    version String
    Gets or sets the version of the module.
    id string
    The provider-assigned unique ID for this managed resource.
    type string
    The type of the resource.
    activityCount number
    Gets or sets the activity count of the module.
    creationTime string
    Gets or sets the creation time.
    description string
    Gets or sets the description.
    error ModuleErrorInfoResponse
    Gets or sets the error info of the module.
    etag string
    Gets or sets the etag of the resource.
    isComposite boolean
    Gets or sets type of module, if its composite or not.
    isGlobal boolean
    Gets or sets the isGlobal flag of the module.
    lastModifiedTime string
    Gets or sets the last modified time.
    provisioningState string
    Gets or sets the provisioning state of the module.
    sizeInBytes number
    Gets or sets the size in bytes of the module.
    version string
    Gets or sets the version of the module.
    id str
    The provider-assigned unique ID for this managed resource.
    type str
    The type of the resource.
    activity_count int
    Gets or sets the activity count of the module.
    creation_time str
    Gets or sets the creation time.
    description str
    Gets or sets the description.
    error ModuleErrorInfoResponse
    Gets or sets the error info of the module.
    etag str
    Gets or sets the etag of the resource.
    is_composite bool
    Gets or sets type of module, if its composite or not.
    is_global bool
    Gets or sets the isGlobal flag of the module.
    last_modified_time str
    Gets or sets the last modified time.
    provisioning_state str
    Gets or sets the provisioning state of the module.
    size_in_bytes float
    Gets or sets the size in bytes of the module.
    version str
    Gets or sets the version of the module.
    id String
    The provider-assigned unique ID for this managed resource.
    type String
    The type of the resource.
    activityCount Number
    Gets or sets the activity count of the module.
    creationTime String
    Gets or sets the creation time.
    description String
    Gets or sets the description.
    error Property Map
    Gets or sets the error info of the module.
    etag String
    Gets or sets the etag of the resource.
    isComposite Boolean
    Gets or sets type of module, if its composite or not.
    isGlobal Boolean
    Gets or sets the isGlobal flag of the module.
    lastModifiedTime String
    Gets or sets the last modified time.
    provisioningState String
    Gets or sets the provisioning state of the module.
    sizeInBytes Number
    Gets or sets the size in bytes of the module.
    version String
    Gets or sets the version of the module.

    Supporting Types

    ContentHash, ContentHashArgs

    Algorithm string
    Gets or sets the content hash algorithm used to hash the content.
    Value string
    Gets or sets expected hash value of the content.
    Algorithm string
    Gets or sets the content hash algorithm used to hash the content.
    Value string
    Gets or sets expected hash value of the content.
    algorithm String
    Gets or sets the content hash algorithm used to hash the content.
    value String
    Gets or sets expected hash value of the content.
    algorithm string
    Gets or sets the content hash algorithm used to hash the content.
    value string
    Gets or sets expected hash value of the content.
    algorithm str
    Gets or sets the content hash algorithm used to hash the content.
    value str
    Gets or sets expected hash value of the content.
    algorithm String
    Gets or sets the content hash algorithm used to hash the content.
    value String
    Gets or sets expected hash value of the content.

    ContentHashResponse, ContentHashResponseArgs

    Algorithm string
    Gets or sets the content hash algorithm used to hash the content.
    Value string
    Gets or sets expected hash value of the content.
    Algorithm string
    Gets or sets the content hash algorithm used to hash the content.
    Value string
    Gets or sets expected hash value of the content.
    algorithm String
    Gets or sets the content hash algorithm used to hash the content.
    value String
    Gets or sets expected hash value of the content.
    algorithm string
    Gets or sets the content hash algorithm used to hash the content.
    value string
    Gets or sets expected hash value of the content.
    algorithm str
    Gets or sets the content hash algorithm used to hash the content.
    value str
    Gets or sets expected hash value of the content.
    algorithm String
    Gets or sets the content hash algorithm used to hash the content.
    value String
    Gets or sets expected hash value of the content.
    ContentHash Pulumi.AzureNative.Automation.Inputs.ContentHash
    Gets or sets the hash.
    Uri string
    Gets or sets the uri of the runbook content.
    Version string
    Gets or sets the version of the content.
    ContentHash ContentHash
    Gets or sets the hash.
    Uri string
    Gets or sets the uri of the runbook content.
    Version string
    Gets or sets the version of the content.
    contentHash ContentHash
    Gets or sets the hash.
    uri String
    Gets or sets the uri of the runbook content.
    version String
    Gets or sets the version of the content.
    contentHash ContentHash
    Gets or sets the hash.
    uri string
    Gets or sets the uri of the runbook content.
    version string
    Gets or sets the version of the content.
    content_hash ContentHash
    Gets or sets the hash.
    uri str
    Gets or sets the uri of the runbook content.
    version str
    Gets or sets the version of the content.
    contentHash Property Map
    Gets or sets the hash.
    uri String
    Gets or sets the uri of the runbook content.
    version String
    Gets or sets the version of the content.

    ContentLinkResponse, ContentLinkResponseArgs

    ContentHash Pulumi.AzureNative.Automation.Inputs.ContentHashResponse
    Gets or sets the hash.
    Uri string
    Gets or sets the uri of the runbook content.
    Version string
    Gets or sets the version of the content.
    ContentHash ContentHashResponse
    Gets or sets the hash.
    Uri string
    Gets or sets the uri of the runbook content.
    Version string
    Gets or sets the version of the content.
    contentHash ContentHashResponse
    Gets or sets the hash.
    uri String
    Gets or sets the uri of the runbook content.
    version String
    Gets or sets the version of the content.
    contentHash ContentHashResponse
    Gets or sets the hash.
    uri string
    Gets or sets the uri of the runbook content.
    version string
    Gets or sets the version of the content.
    content_hash ContentHashResponse
    Gets or sets the hash.
    uri str
    Gets or sets the uri of the runbook content.
    version str
    Gets or sets the version of the content.
    contentHash Property Map
    Gets or sets the hash.
    uri String
    Gets or sets the uri of the runbook content.
    version String
    Gets or sets the version of the content.

    ModuleErrorInfoResponse, ModuleErrorInfoResponseArgs

    Code string
    Gets or sets the error code.
    Message string
    Gets or sets the error message.
    Code string
    Gets or sets the error code.
    Message string
    Gets or sets the error message.
    code String
    Gets or sets the error code.
    message String
    Gets or sets the error message.
    code string
    Gets or sets the error code.
    message string
    Gets or sets the error message.
    code str
    Gets or sets the error code.
    message str
    Gets or sets the error message.
    code String
    Gets or sets the error code.
    message String
    Gets or sets the error message.

    Import

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

    $ pulumi import azure-native:automation:Module OmsCompositeResources /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/modules/{moduleName} 
    

    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.46.0 published on Friday, Jun 21, 2024 by Pulumi