1. Packages
  2. Azure Classic
  3. API Docs
  4. automation
  5. getAccount

We recommend using Azure Native.

Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi

azure.automation.getAccount

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi

    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/v5/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.applyValue(getAccountResult -> getAccountResult.id()));
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: azure:automation:getAccount
          Arguments:
            name: example-account
            resourceGroupName: example-resources
    outputs:
      automationAccountId: ${example.id}
    

    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)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure:automation/getAccount:getAccount
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    The name of the Automation Account.
    ResourceGroupName string
    Specifies the name of the Resource Group where the Automation Account exists.
    Name string
    The name of the Automation Account.
    ResourceGroupName string
    Specifies the name of the Resource Group where the Automation Account exists.
    name String
    The name of the Automation Account.
    resourceGroupName String
    Specifies the name of the Resource Group where the Automation Account exists.
    name string
    The name of the Automation Account.
    resourceGroupName string
    Specifies the name of the Resource Group where the Automation Account exists.
    name str
    The name of the Automation Account.
    resource_group_name str
    Specifies the name of the Resource Group where the Automation Account exists.
    name String
    The name of the Automation Account.
    resourceGroupName String
    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.
    HybridServiceUrl string
    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<GetAccountIdentity>
    (Optional) An identity block as defined below.
    Name string
    PrimaryKey string
    The Primary Access Key for the Automation Account.
    PrivateEndpointConnections List<GetAccountPrivateEndpointConnection>
    ResourceGroupName string
    SecondaryKey string
    The Secondary Access Key for the Automation Account.
    Endpoint string
    The Endpoint for this Automation Account.
    HybridServiceUrl string
    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 []GetAccountIdentity
    (Optional) An identity block as defined below.
    Name string
    PrimaryKey string
    The Primary Access Key for the Automation Account.
    PrivateEndpointConnections []GetAccountPrivateEndpointConnection
    ResourceGroupName string
    SecondaryKey string
    The Secondary Access Key for the Automation Account.
    endpoint String
    The Endpoint for this Automation Account.
    hybridServiceUrl String
    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<GetAccountIdentity>
    (Optional) An identity block as defined below.
    name String
    primaryKey String
    The Primary Access Key for the Automation Account.
    privateEndpointConnections List<GetAccountPrivateEndpointConnection>
    resourceGroupName String
    secondaryKey String
    The Secondary Access Key for the Automation Account.
    endpoint string
    The Endpoint for this Automation Account.
    hybridServiceUrl string
    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 GetAccountIdentity[]
    (Optional) An identity block as defined below.
    name string
    primaryKey string
    The Primary Access Key for the Automation Account.
    privateEndpointConnections GetAccountPrivateEndpointConnection[]
    resourceGroupName string
    secondaryKey string
    The Secondary Access Key for the Automation Account.
    endpoint str
    The Endpoint for this Automation Account.
    hybrid_service_url str
    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[GetAccountIdentity]
    (Optional) An identity block as defined below.
    name str
    primary_key str
    The Primary Access Key for the Automation Account.
    private_endpoint_connections Sequence[GetAccountPrivateEndpointConnection]
    resource_group_name str
    secondary_key str
    The Secondary Access Key for the Automation Account.
    endpoint String
    The Endpoint for this Automation Account.
    hybridServiceUrl String
    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 identity block as defined below.
    name String
    primaryKey String
    The Primary Access Key for the Automation Account.
    privateEndpointConnections List<Property Map>
    resourceGroupName String
    secondaryKey String
    The Secondary Access Key for the Automation Account.

    Supporting Types

    GetAccountIdentity

    IdentityIds List<string>
    The list of User Assigned Managed Identity IDs assigned to this Automation Account.
    PrincipalId string
    The Principal ID of the System Assigned Managed Service Identity that is configured on this Automation Account.
    TenantId 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.
    IdentityIds []string
    The list of User Assigned Managed Identity IDs assigned to this Automation Account.
    PrincipalId string
    The Principal ID of the System Assigned Managed Service Identity that is configured on this Automation Account.
    TenantId 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.
    identityIds List<String>
    The list of User Assigned Managed Identity IDs assigned to this Automation Account.
    principalId String
    The Principal ID of the System Assigned Managed Service Identity that is configured on this Automation Account.
    tenantId 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.
    identityIds string[]
    The list of User Assigned Managed Identity IDs assigned to this Automation Account.
    principalId string
    The Principal ID of the System Assigned Managed Service Identity that is configured on this Automation Account.
    tenantId 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.
    identityIds List<String>
    The list of User Assigned Managed Identity IDs assigned to this Automation Account.
    principalId String
    The Principal ID of the System Assigned Managed Service Identity that is configured on this Automation Account.
    tenantId 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

    Id string
    The ID of the Automation Account
    Name string
    The name of the Automation Account.
    Id string
    The ID of the Automation Account
    Name string
    The name of the Automation Account.
    id String
    The ID of the Automation Account
    name String
    The name of the Automation Account.
    id string
    The ID of the Automation Account
    name string
    The name of the Automation Account.
    id str
    The ID of the Automation Account
    name str
    The name of the Automation Account.
    id String
    The ID of the Automation Account
    name String
    The name of the Automation Account.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi