1. Packages
  2. Azure Native
  3. API Docs
  4. automation
  5. getModule
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

azure-native.automation.getModule

Explore with Pulumi AI

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.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

    Retrieve the module identified by module name.

    Uses Azure REST API version 2023-11-01.

    Other available API versions: 2015-10-31, 2019-06-01, 2020-01-13-preview, 2022-08-08, 2023-05-15-preview, 2024-10-23. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native automation [ApiVersion]. See the version guide for details.

    Using getModule

    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 getModule(args: GetModuleArgs, opts?: InvokeOptions): Promise<GetModuleResult>
    function getModuleOutput(args: GetModuleOutputArgs, opts?: InvokeOptions): Output<GetModuleResult>
    def get_module(automation_account_name: Optional[str] = None,
                   module_name: Optional[str] = None,
                   resource_group_name: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetModuleResult
    def get_module_output(automation_account_name: Optional[pulumi.Input[str]] = None,
                   module_name: Optional[pulumi.Input[str]] = None,
                   resource_group_name: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetModuleResult]
    func LookupModule(ctx *Context, args *LookupModuleArgs, opts ...InvokeOption) (*LookupModuleResult, error)
    func LookupModuleOutput(ctx *Context, args *LookupModuleOutputArgs, opts ...InvokeOption) LookupModuleResultOutput

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

    public static class GetModule 
    {
        public static Task<GetModuleResult> InvokeAsync(GetModuleArgs args, InvokeOptions? opts = null)
        public static Output<GetModuleResult> Invoke(GetModuleInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetModuleResult> getModule(GetModuleArgs args, InvokeOptions options)
    public static Output<GetModuleResult> getModule(GetModuleArgs args, InvokeOptions options)
    
    fn::invoke:
      function: azure-native:automation:getModule
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AutomationAccountName string
    The name of the automation account.
    ModuleName string
    The module name.
    ResourceGroupName string
    Name of an Azure Resource group.
    AutomationAccountName string
    The name of the automation account.
    ModuleName string
    The module name.
    ResourceGroupName string
    Name of an Azure Resource group.
    automationAccountName String
    The name of the automation account.
    moduleName String
    The module name.
    resourceGroupName String
    Name of an Azure Resource group.
    automationAccountName string
    The name of the automation account.
    moduleName string
    The module name.
    resourceGroupName string
    Name of an Azure Resource group.
    automation_account_name str
    The name of the automation account.
    module_name str
    The module name.
    resource_group_name str
    Name of an Azure Resource group.
    automationAccountName String
    The name of the automation account.
    moduleName String
    The module name.
    resourceGroupName String
    Name of an Azure Resource group.

    getModule 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
    Name string
    The name of the resource
    Type string
    The type of the resource.
    ActivityCount int
    Gets the activity count of the module.
    CreationTime string
    Gets the creation time.
    Description string
    Gets or sets the description.
    Error Pulumi.AzureNative.Automation.Outputs.ModuleErrorInfoResponse
    Gets the error info of the module.
    Etag string
    Gets the etag of the resource.
    IsComposite bool
    Gets type of module, if its composite or not.
    IsGlobal bool
    Gets the isGlobal flag of the module.
    LastModifiedTime string
    Gets the last modified time.
    Location string
    The Azure Region where the resource lives
    ProvisioningState string
    Gets the provisioning state of the module.
    SizeInBytes double
    Gets the size in bytes of the module.
    Tags Dictionary<string, string>
    Resource tags.
    Version string
    Gets the version of the module.
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource Id for the resource
    Name string
    The name of the resource
    Type string
    The type of the resource.
    ActivityCount int
    Gets the activity count of the module.
    CreationTime string
    Gets the creation time.
    Description string
    Gets or sets the description.
    Error ModuleErrorInfoResponse
    Gets the error info of the module.
    Etag string
    Gets the etag of the resource.
    IsComposite bool
    Gets type of module, if its composite or not.
    IsGlobal bool
    Gets the isGlobal flag of the module.
    LastModifiedTime string
    Gets the last modified time.
    Location string
    The Azure Region where the resource lives
    ProvisioningState string
    Gets the provisioning state of the module.
    SizeInBytes float64
    Gets the size in bytes of the module.
    Tags map[string]string
    Resource tags.
    Version string
    Gets the version of the module.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource Id for the resource
    name String
    The name of the resource
    type String
    The type of the resource.
    activityCount Integer
    Gets the activity count of the module.
    creationTime String
    Gets the creation time.
    description String
    Gets or sets the description.
    error ModuleErrorInfoResponse
    Gets the error info of the module.
    etag String
    Gets the etag of the resource.
    isComposite Boolean
    Gets type of module, if its composite or not.
    isGlobal Boolean
    Gets the isGlobal flag of the module.
    lastModifiedTime String
    Gets the last modified time.
    location String
    The Azure Region where the resource lives
    provisioningState String
    Gets the provisioning state of the module.
    sizeInBytes Double
    Gets the size in bytes of the module.
    tags Map<String,String>
    Resource tags.
    version String
    Gets the version of the module.
    azureApiVersion string
    The Azure API version of the resource.
    id string
    Fully qualified resource Id for the resource
    name string
    The name of the resource
    type string
    The type of the resource.
    activityCount number
    Gets the activity count of the module.
    creationTime string
    Gets the creation time.
    description string
    Gets or sets the description.
    error ModuleErrorInfoResponse
    Gets the error info of the module.
    etag string
    Gets the etag of the resource.
    isComposite boolean
    Gets type of module, if its composite or not.
    isGlobal boolean
    Gets the isGlobal flag of the module.
    lastModifiedTime string
    Gets the last modified time.
    location string
    The Azure Region where the resource lives
    provisioningState string
    Gets the provisioning state of the module.
    sizeInBytes number
    Gets the size in bytes of the module.
    tags {[key: string]: string}
    Resource tags.
    version string
    Gets the version of the module.
    azure_api_version str
    The Azure API version of the resource.
    id str
    Fully qualified resource Id for the resource
    name str
    The name of the resource
    type str
    The type of the resource.
    activity_count int
    Gets the activity count of the module.
    creation_time str
    Gets the creation time.
    description str
    Gets or sets the description.
    error ModuleErrorInfoResponse
    Gets the error info of the module.
    etag str
    Gets the etag of the resource.
    is_composite bool
    Gets type of module, if its composite or not.
    is_global bool
    Gets the isGlobal flag of the module.
    last_modified_time str
    Gets the last modified time.
    location str
    The Azure Region where the resource lives
    provisioning_state str
    Gets the provisioning state of the module.
    size_in_bytes float
    Gets the size in bytes of the module.
    tags Mapping[str, str]
    Resource tags.
    version str
    Gets the version of the module.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource Id for the resource
    name String
    The name of the resource
    type String
    The type of the resource.
    activityCount Number
    Gets the activity count of the module.
    creationTime String
    Gets the creation time.
    description String
    Gets or sets the description.
    error Property Map
    Gets the error info of the module.
    etag String
    Gets the etag of the resource.
    isComposite Boolean
    Gets type of module, if its composite or not.
    isGlobal Boolean
    Gets the isGlobal flag of the module.
    lastModifiedTime String
    Gets the last modified time.
    location String
    The Azure Region where the resource lives
    provisioningState String
    Gets the provisioning state of the module.
    sizeInBytes Number
    Gets the size in bytes of the module.
    tags Map<String>
    Resource tags.
    version String
    Gets the version of the module.

    Supporting Types

    ModuleErrorInfoResponse

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

    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.
    Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi