published on Friday, Mar 20, 2026 by Pulumi
published on Friday, Mar 20, 2026 by Pulumi
Retrieve the module identified by module name.
Uses Azure REST API version 2024-10-23.
Other available API versions: 2015-10-31, 2019-06-01, 2020-01-13-preview, 2022-08-08, 2023-05-15-preview, 2023-11-01. 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 dictionaryThe following arguments are supported:
- Automation
Account stringName - The name of the automation account.
- Module
Name string - The module name.
- Resource
Group stringName - Name of an Azure Resource group.
- Automation
Account stringName - The name of the automation account.
- Module
Name string - The module name.
- Resource
Group stringName - Name of an Azure Resource group.
- automation
Account StringName - The name of the automation account.
- module
Name String - The module name.
- resource
Group StringName - Name of an Azure Resource group.
- automation
Account stringName - The name of the automation account.
- module
Name string - The module name.
- resource
Group stringName - Name of an Azure Resource group.
- automation_
account_ strname - The name of the automation account.
- module_
name str - The module name.
- resource_
group_ strname - Name of an Azure Resource group.
- automation
Account StringName - The name of the automation account.
- module
Name String - The module name.
- resource
Group StringName - Name of an Azure Resource group.
getModule Result
The following output properties are available:
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- Location string
- The geo-location where the resource lives
- Name string
- The name of the resource
- System
Data Pulumi.Azure Native. Automation. Outputs. System Data Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Activity
Count int - Gets or sets the activity count of the module.
- Content
Link Pulumi.Azure Native. Automation. Outputs. Content Link Response - Gets or sets the contentLink of the module.
- Creation
Time string - Gets or sets the creation time.
- Description string
- Gets or sets the description.
- Error
Pulumi.
Azure Native. Automation. Outputs. Module Error Info Response - Gets or sets the error info of the module.
- Etag string
- 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 stringTime - Gets or sets the last modified time.
- Provisioning
State string - Gets or sets the provisioning state of the module.
- Size
In doubleBytes - Gets or sets the size in bytes of the module.
- Dictionary<string, string>
- Resource tags.
- Version string
- Gets or sets the version of the module.
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- Location string
- The geo-location where the resource lives
- Name string
- The name of the resource
- System
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Activity
Count int - Gets or sets the activity count of the module.
- Content
Link ContentLink Response - Gets or sets the contentLink of the module.
- Creation
Time string - Gets or sets the creation time.
- Description string
- Gets or sets the description.
- Error
Module
Error Info Response - Gets or sets the error info of the module.
- Etag string
- 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 stringTime - Gets or sets the last modified time.
- Provisioning
State string - Gets or sets the provisioning state of the module.
- Size
In float64Bytes - Gets or sets the size in bytes of the module.
- map[string]string
- Resource tags.
- Version string
- Gets or sets the version of the module.
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- location String
- The geo-location where the resource lives
- name String
- The name of the resource
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- activity
Count Integer - Gets or sets the activity count of the module.
- content
Link ContentLink Response - Gets or sets the contentLink of the module.
- creation
Time String - Gets or sets the creation time.
- description String
- Gets or sets the description.
- error
Module
Error Info Response - Gets or sets the error info of the module.
- etag String
- Gets or sets the etag of the resource.
- is
Composite Boolean - Gets or sets type of module, if its composite or not.
- is
Global Boolean - Gets or sets the isGlobal flag of the module.
- last
Modified StringTime - Gets or sets the last modified time.
- provisioning
State String - Gets or sets the provisioning state of the module.
- size
In DoubleBytes - Gets or sets the size in bytes of the module.
- Map<String,String>
- Resource tags.
- version String
- Gets or sets the version of the module.
- azure
Api stringVersion - The Azure API version of the resource.
- id string
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- location string
- The geo-location where the resource lives
- name string
- The name of the resource
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- activity
Count number - Gets or sets the activity count of the module.
- content
Link ContentLink Response - Gets or sets the contentLink of the module.
- creation
Time string - Gets or sets the creation time.
- description string
- Gets or sets the description.
- error
Module
Error Info Response - Gets or sets the error info of the module.
- etag string
- Gets or sets the etag of the resource.
- is
Composite boolean - Gets or sets type of module, if its composite or not.
- is
Global boolean - Gets or sets the isGlobal flag of the module.
- last
Modified stringTime - Gets or sets the last modified time.
- provisioning
State string - Gets or sets the provisioning state of the module.
- size
In numberBytes - Gets or sets the size in bytes of the module.
- {[key: string]: string}
- Resource tags.
- version string
- Gets or sets the version of the module.
- azure_
api_ strversion - The Azure API version of the resource.
- id str
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- location str
- The geo-location where the resource lives
- name str
- The name of the resource
- system_
data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- activity_
count int - Gets or sets the activity count of the module.
- content_
link ContentLink Response - 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
Module
Error Info Response - 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_ strtime - Gets or sets the last modified time.
- provisioning_
state str - Gets or sets the provisioning state of the module.
- size_
in_ floatbytes - Gets or sets the size in bytes of the module.
- Mapping[str, str]
- Resource tags.
- version str
- Gets or sets the version of the module.
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- location String
- The geo-location where the resource lives
- name String
- The name of the resource
- system
Data Property Map - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- activity
Count Number - Gets or sets the activity count of the module.
- content
Link Property Map - Gets or sets the contentLink of the module.
- creation
Time 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.
- is
Composite Boolean - Gets or sets type of module, if its composite or not.
- is
Global Boolean - Gets or sets the isGlobal flag of the module.
- last
Modified StringTime - Gets or sets the last modified time.
- provisioning
State String - Gets or sets the provisioning state of the module.
- size
In NumberBytes - Gets or sets the size in bytes of the module.
- Map<String>
- Resource tags.
- version String
- Gets or sets the version of the module.
Supporting Types
ContentHashResponse
ContentLinkResponse
- Content
Hash Pulumi.Azure Native. Automation. Inputs. Content Hash Response - Gets or sets the hash.
- Uri string
- Gets or sets the uri of content.
- Version string
- Gets or sets the version of the content.
- Content
Hash ContentHash Response - Gets or sets the hash.
- Uri string
- Gets or sets the uri of content.
- Version string
- Gets or sets the version of the content.
- content
Hash ContentHash Response - Gets or sets the hash.
- uri String
- Gets or sets the uri of content.
- version String
- Gets or sets the version of the content.
- content
Hash ContentHash Response - Gets or sets the hash.
- uri string
- Gets or sets the uri of content.
- version string
- Gets or sets the version of the content.
- content_
hash ContentHash Response - Gets or sets the hash.
- uri str
- Gets or sets the uri of content.
- version str
- Gets or sets the version of the content.
- content
Hash Property Map - Gets or sets the hash.
- uri String
- Gets or sets the uri of content.
- version String
- Gets or sets the version of the content.
ModuleErrorInfoResponse
SystemDataResponse
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - 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_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
published on Friday, Mar 20, 2026 by Pulumi
