1. Packages
  2. Azure Native
  3. API Docs
  4. automation
  5. getModule
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.getModule

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

    Retrieve the module identified by module name. Azure REST API version: 2022-08-08.

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

    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)
    // Output-based functions aren't available in Java yet
    
    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:

    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 or sets the activity count of the module.
    ContentLink Pulumi.AzureNative.Automation.Outputs.ContentLinkResponse
    Gets or sets the contentLink 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.
    Location string
    The Azure Region where the resource lives
    ProvisioningState string
    Gets or sets the provisioning state of the module.
    SizeInBytes double
    Gets or sets the size in bytes of the module.
    Tags Dictionary<string, string>
    Resource tags.
    Version string
    Gets or sets the version of the module.
    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 or sets the activity count of the module.
    ContentLink ContentLinkResponse
    Gets or sets the contentLink 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.
    Location string
    The Azure Region where the resource lives
    ProvisioningState string
    Gets or sets the provisioning state of the module.
    SizeInBytes float64
    Gets or sets the size in bytes of the module.
    Tags map[string]string
    Resource tags.
    Version string
    Gets or sets the version of the module.
    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 or sets the activity count of the module.
    contentLink ContentLinkResponse
    Gets or sets the contentLink 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.
    location String
    The Azure Region where the resource lives
    provisioningState String
    Gets or sets the provisioning state of the module.
    sizeInBytes Double
    Gets or sets the size in bytes of the module.
    tags Map<String,String>
    Resource tags.
    version String
    Gets or sets the version of the module.
    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 or sets the activity count of the module.
    contentLink ContentLinkResponse
    Gets or sets the contentLink 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.
    location string
    The Azure Region where the resource lives
    provisioningState string
    Gets or sets the provisioning state of the module.
    sizeInBytes number
    Gets or sets the size in bytes of the module.
    tags {[key: string]: string}
    Resource tags.
    version string
    Gets or sets the version of the module.
    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 or sets the activity count of the module.
    content_link ContentLinkResponse
    Gets or sets the contentLink 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.
    location str
    The Azure Region where the resource lives
    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.
    tags Mapping[str, str]
    Resource tags.
    version str
    Gets or sets the version of the module.
    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 or sets the activity count of the module.
    contentLink Property Map
    Gets or sets the contentLink 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.
    location String
    The Azure Region where the resource lives
    provisioningState String
    Gets or sets the provisioning state of the module.
    sizeInBytes Number
    Gets or sets the size in bytes of the module.
    tags Map<String>
    Resource tags.
    version String
    Gets or sets the version of the module.

    Supporting Types

    ContentHashResponse

    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.

    ContentLinkResponse

    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

    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.

    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