We recommend using Azure Native.
Azure v6.28.0 published on Friday, Oct 3, 2025 by Pulumi
azure.automation.getAccount
Use this data source to access information about an existing Automation Account.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = azure.automation.getAccount({
name: "example-account",
resourceGroupName: "example-resources",
});
export const automationAccountId = example.then(example => example.id);
import pulumi
import pulumi_azure as azure
example = azure.automation.get_account(name="example-account",
resource_group_name="example-resources")
pulumi.export("automationAccountId", example.id)
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/automation"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := automation.LookupAccount(ctx, &automation.LookupAccountArgs{
Name: "example-account",
ResourceGroupName: "example-resources",
}, nil)
if err != nil {
return err
}
ctx.Export("automationAccountId", example.Id)
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var example = Azure.Automation.GetAccount.Invoke(new()
{
Name = "example-account",
ResourceGroupName = "example-resources",
});
return new Dictionary<string, object?>
{
["automationAccountId"] = example.Apply(getAccountResult => getAccountResult.Id),
};
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.automation.AutomationFunctions;
import com.pulumi.azure.automation.inputs.GetAccountArgs;
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) {
final var example = AutomationFunctions.getAccount(GetAccountArgs.builder()
.name("example-account")
.resourceGroupName("example-resources")
.build());
ctx.export("automationAccountId", example.id());
}
}
variables:
example:
fn::invoke:
function: azure:automation:getAccount
arguments:
name: example-account
resourceGroupName: example-resources
outputs:
automationAccountId: ${example.id}
API Providers
This data source uses the following Azure API Providers:
Microsoft.Automation- 2023-11-01, 2019-06-01
Using getAccount
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 getAccount(args: GetAccountArgs, opts?: InvokeOptions): Promise<GetAccountResult>
function getAccountOutput(args: GetAccountOutputArgs, opts?: InvokeOptions): Output<GetAccountResult>def get_account(name: Optional[str] = None,
resource_group_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetAccountResult
def get_account_output(name: Optional[pulumi.Input[str]] = None,
resource_group_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetAccountResult]func LookupAccount(ctx *Context, args *LookupAccountArgs, opts ...InvokeOption) (*LookupAccountResult, error)
func LookupAccountOutput(ctx *Context, args *LookupAccountOutputArgs, opts ...InvokeOption) LookupAccountResultOutput> Note: This function is named LookupAccount in the Go SDK.
public static class GetAccount
{
public static Task<GetAccountResult> InvokeAsync(GetAccountArgs args, InvokeOptions? opts = null)
public static Output<GetAccountResult> Invoke(GetAccountInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetAccountResult> getAccount(GetAccountArgs args, InvokeOptions options)
public static Output<GetAccountResult> getAccount(GetAccountArgs args, InvokeOptions options)
fn::invoke:
function: azure:automation/getAccount:getAccount
arguments:
# arguments dictionaryThe following arguments are supported:
- Name string
- The name of the Automation Account.
- Resource
Group stringName - Specifies the name of the Resource Group where the Automation Account exists.
- Name string
- The name of the Automation Account.
- Resource
Group stringName - Specifies the name of the Resource Group where the Automation Account exists.
- name String
- The name of the Automation Account.
- resource
Group StringName - Specifies the name of the Resource Group where the Automation Account exists.
- name string
- The name of the Automation Account.
- resource
Group stringName - Specifies the name of the Resource Group where the Automation Account exists.
- name str
- The name of the Automation Account.
- resource_
group_ strname - Specifies the name of the Resource Group where the Automation Account exists.
- name String
- The name of the Automation Account.
- resource
Group StringName - Specifies the name of the Resource Group where the Automation Account exists.
getAccount Result
The following output properties are available:
- Endpoint string
- The Endpoint for this Automation Account.
- Hybrid
Service stringUrl - The URL of automation hybrid service which is used for hybrid worker on-boarding With this Automation Account.
- Id string
- The provider-assigned unique ID for this managed resource.
- Identities
List<Get
Account Identity> - (Optional) An
identityblock as defined below. - Name string
- Primary
Key string - The Primary Access Key for the Automation Account.
- Private
Endpoint List<GetConnections Account Private Endpoint Connection> - Resource
Group stringName - Secondary
Key string - The Secondary Access Key for the Automation Account.
- Endpoint string
- The Endpoint for this Automation Account.
- Hybrid
Service stringUrl - The URL of automation hybrid service which is used for hybrid worker on-boarding With this Automation Account.
- Id string
- The provider-assigned unique ID for this managed resource.
- Identities
[]Get
Account Identity - (Optional) An
identityblock as defined below. - Name string
- Primary
Key string - The Primary Access Key for the Automation Account.
- Private
Endpoint []GetConnections Account Private Endpoint Connection - Resource
Group stringName - Secondary
Key string - The Secondary Access Key for the Automation Account.
- endpoint String
- The Endpoint for this Automation Account.
- hybrid
Service StringUrl - The URL of automation hybrid service which is used for hybrid worker on-boarding With this Automation Account.
- id String
- The provider-assigned unique ID for this managed resource.
- identities
List<Get
Account Identity> - (Optional) An
identityblock as defined below. - name String
- primary
Key String - The Primary Access Key for the Automation Account.
- private
Endpoint List<GetConnections Account Private Endpoint Connection> - resource
Group StringName - secondary
Key String - The Secondary Access Key for the Automation Account.
- endpoint string
- The Endpoint for this Automation Account.
- hybrid
Service stringUrl - The URL of automation hybrid service which is used for hybrid worker on-boarding With this Automation Account.
- id string
- The provider-assigned unique ID for this managed resource.
- identities
Get
Account Identity[] - (Optional) An
identityblock as defined below. - name string
- primary
Key string - The Primary Access Key for the Automation Account.
- private
Endpoint GetConnections Account Private Endpoint Connection[] - resource
Group stringName - secondary
Key string - The Secondary Access Key for the Automation Account.
- endpoint str
- The Endpoint for this Automation Account.
- hybrid_
service_ strurl - The URL of automation hybrid service which is used for hybrid worker on-boarding With this Automation Account.
- id str
- The provider-assigned unique ID for this managed resource.
- identities
Sequence[Get
Account Identity] - (Optional) An
identityblock as defined below. - name str
- primary_
key str - The Primary Access Key for the Automation Account.
- private_
endpoint_ Sequence[Getconnections Account Private Endpoint Connection] - resource_
group_ strname - secondary_
key str - The Secondary Access Key for the Automation Account.
- endpoint String
- The Endpoint for this Automation Account.
- hybrid
Service StringUrl - The URL of automation hybrid service which is used for hybrid worker on-boarding With this Automation Account.
- id String
- The provider-assigned unique ID for this managed resource.
- identities List<Property Map>
- (Optional) An
identityblock as defined below. - name String
- primary
Key String - The Primary Access Key for the Automation Account.
- private
Endpoint List<Property Map>Connections - resource
Group StringName - secondary
Key String - The Secondary Access Key for the Automation Account.
Supporting Types
GetAccountIdentity
- Identity
Ids List<string> - The list of User Assigned Managed Identity IDs assigned to this Automation Account.
- Principal
Id string - The Principal ID of the System Assigned Managed Service Identity that is configured on this Automation Account.
- Tenant
Id string - The Tenant ID of the System Assigned Managed Service Identity that is configured on this Automation Account.
- Type string
- The type of Managed Service Identity that is configured on this Automation Account.
- Identity
Ids []string - The list of User Assigned Managed Identity IDs assigned to this Automation Account.
- Principal
Id string - The Principal ID of the System Assigned Managed Service Identity that is configured on this Automation Account.
- Tenant
Id string - The Tenant ID of the System Assigned Managed Service Identity that is configured on this Automation Account.
- Type string
- The type of Managed Service Identity that is configured on this Automation Account.
- identity
Ids List<String> - The list of User Assigned Managed Identity IDs assigned to this Automation Account.
- principal
Id String - The Principal ID of the System Assigned Managed Service Identity that is configured on this Automation Account.
- tenant
Id String - The Tenant ID of the System Assigned Managed Service Identity that is configured on this Automation Account.
- type String
- The type of Managed Service Identity that is configured on this Automation Account.
- identity
Ids string[] - The list of User Assigned Managed Identity IDs assigned to this Automation Account.
- principal
Id string - The Principal ID of the System Assigned Managed Service Identity that is configured on this Automation Account.
- tenant
Id string - The Tenant ID of the System Assigned Managed Service Identity that is configured on this Automation Account.
- type string
- The type of Managed Service Identity that is configured on this Automation Account.
- identity_
ids Sequence[str] - The list of User Assigned Managed Identity IDs assigned to this Automation Account.
- principal_
id str - The Principal ID of the System Assigned Managed Service Identity that is configured on this Automation Account.
- tenant_
id str - The Tenant ID of the System Assigned Managed Service Identity that is configured on this Automation Account.
- type str
- The type of Managed Service Identity that is configured on this Automation Account.
- identity
Ids List<String> - The list of User Assigned Managed Identity IDs assigned to this Automation Account.
- principal
Id String - The Principal ID of the System Assigned Managed Service Identity that is configured on this Automation Account.
- tenant
Id String - The Tenant ID of the System Assigned Managed Service Identity that is configured on this Automation Account.
- type String
- The type of Managed Service Identity that is configured on this Automation Account.
GetAccountPrivateEndpointConnection
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
azurermTerraform Provider.
