Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. automation
  5. Credential

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

azure.automation.Credential

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

    Manages a Automation Credential.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleAccount = new azure.automation.Account("example", {
    name: "account1",
    location: example.location,
    resourceGroupName: example.name,
    skuName: "Basic",
});
const exampleCredential = new azure.automation.Credential("example", {
    name: "credential1",
    resourceGroupName: example.name,
    automationAccountName: exampleAccount.name,
    username: "example_user",
    password: "example_pwd",
    description: "This is an example credential",
});

    import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_account = azure.automation.Account("example",
    name="account1",
    location=example.location,
    resource_group_name=example.name,
    sku_name="Basic")
example_credential = azure.automation.Credential("example",
    name="credential1",
    resource_group_name=example.name,
    automation_account_name=example_account.name,
    username="example_user",
    password="example_pwd",
    description="This is an example credential")

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/automation"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleAccount, err := automation.NewAccount(ctx, "example", &automation.AccountArgs{
			Name:              pulumi.String("account1"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
			SkuName:           pulumi.String("Basic"),
		})
		if err != nil {
			return err
		}
		_, err = automation.NewCredential(ctx, "example", &automation.CredentialArgs{
			Name:                  pulumi.String("credential1"),
			ResourceGroupName:     example.Name,
			AutomationAccountName: exampleAccount.Name,
			Username:              pulumi.String("example_user"),
			Password:              pulumi.String("example_pwd"),
			Description:           pulumi.String("This is an example credential"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

    var exampleAccount = new Azure.Automation.Account("example", new()
    {
        Name = "account1",
        Location = example.Location,
        ResourceGroupName = example.Name,
        SkuName = "Basic",
    });

    var exampleCredential = new Azure.Automation.Credential("example", new()
    {
        Name = "credential1",
        ResourceGroupName = example.Name,
        AutomationAccountName = exampleAccount.Name,
        Username = "example_user",
        Password = "example_pwd",
        Description = "This is an example credential",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.automation.Account;
import com.pulumi.azure.automation.AccountArgs;
import com.pulumi.azure.automation.Credential;
import com.pulumi.azure.automation.CredentialArgs;
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) {
        var example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        var exampleAccount = new Account("exampleAccount", AccountArgs.builder()
            .name("account1")
            .location(example.location())
            .resourceGroupName(example.name())
            .skuName("Basic")
            .build());

        var exampleCredential = new Credential("exampleCredential", CredentialArgs.builder()
            .name("credential1")
            .resourceGroupName(example.name())
            .automationAccountName(exampleAccount.name())
            .username("example_user")
            .password("example_pwd")
            .description("This is an example credential")
            .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleAccount:
    type: azure:automation:Account
    name: example
    properties:
      name: account1
      location: ${example.location}
      resourceGroupName: ${example.name}
      skuName: Basic
  exampleCredential:
    type: azure:automation:Credential
    name: example
    properties:
      name: credential1
      resourceGroupName: ${example.name}
      automationAccountName: ${exampleAccount.name}
      username: example_user
      password: example_pwd
      description: This is an example credential

    Create Credential Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Credential(name: string, args: CredentialArgs, opts?: CustomResourceOptions);
    @overload
def Credential(resource_name: str,
               args: CredentialArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def Credential(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               automation_account_name: Optional[str] = None,
               password: Optional[str] = None,
               resource_group_name: Optional[str] = None,
               username: Optional[str] = None,
               description: Optional[str] = None,
               name: Optional[str] = None)
    func NewCredential(ctx *Context, name string, args CredentialArgs, opts ...ResourceOption) (*Credential, error)
    public Credential(string name, CredentialArgs args, CustomResourceOptions? opts = null)
    public Credential(String name, CredentialArgs args)
public Credential(String name, CredentialArgs args, CustomResourceOptions options)

    type: azure:automation:Credential
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args CredentialArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args CredentialArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args CredentialArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CredentialArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CredentialArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var credentialResource = new Azure.Automation.Credential("credentialResource", new()
{
    AutomationAccountName = "string",
    Password = "string",
    ResourceGroupName = "string",
    Username = "string",
    Description = "string",
    Name = "string",
});

    example, err := automation.NewCredential(ctx, "credentialResource", &automation.CredentialArgs{
	AutomationAccountName: pulumi.String("string"),
	Password:              pulumi.String("string"),
	ResourceGroupName:     pulumi.String("string"),
	Username:              pulumi.String("string"),
	Description:           pulumi.String("string"),
	Name:                  pulumi.String("string"),
})

    var credentialResource = new Credential("credentialResource", CredentialArgs.builder()
    .automationAccountName("string")
    .password("string")
    .resourceGroupName("string")
    .username("string")
    .description("string")
    .name("string")
    .build());

    credential_resource = azure.automation.Credential("credentialResource",
    automation_account_name="string",
    password="string",
    resource_group_name="string",
    username="string",
    description="string",
    name="string")

    const credentialResource = new azure.automation.Credential("credentialResource", {
    automationAccountName: "string",
    password: "string",
    resourceGroupName: "string",
    username: "string",
    description: "string",
    name: "string",
});

    type: azure:automation:Credential
properties:
    automationAccountName: string
    description: string
    name: string
    password: string
    resourceGroupName: string
    username: string

    Credential Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Credential resource accepts the following input properties:

    AutomationAccountName string
    The name of the automation account in which the Credential is created. Changing this forces a new resource to be created.
    Password string
    The password associated with this Automation Credential.
    ResourceGroupName string
    The name of the resource group in which the Credential is created. Changing this forces a new resource to be created.
    Username string
    The username associated with this Automation Credential.
    Description string
    The description associated with this Automation Credential.
    Name string
    Specifies the name of the Credential. Changing this forces a new resource to be created.
    AutomationAccountName string
    The name of the automation account in which the Credential is created. Changing this forces a new resource to be created.
    Password string
    The password associated with this Automation Credential.
    ResourceGroupName string
    The name of the resource group in which the Credential is created. Changing this forces a new resource to be created.
    Username string
    The username associated with this Automation Credential.
    Description string
    The description associated with this Automation Credential.
    Name string
    Specifies the name of the Credential. Changing this forces a new resource to be created.
    automationAccountName String
    The name of the automation account in which the Credential is created. Changing this forces a new resource to be created.
    password String
    The password associated with this Automation Credential.
    resourceGroupName String
    The name of the resource group in which the Credential is created. Changing this forces a new resource to be created.
    username String
    The username associated with this Automation Credential.
    description String
    The description associated with this Automation Credential.
    name String
    Specifies the name of the Credential. Changing this forces a new resource to be created.
    automationAccountName string
    The name of the automation account in which the Credential is created. Changing this forces a new resource to be created.
    password string
    The password associated with this Automation Credential.
    resourceGroupName string
    The name of the resource group in which the Credential is created. Changing this forces a new resource to be created.
    username string
    The username associated with this Automation Credential.
    description string
    The description associated with this Automation Credential.
    name string
    Specifies the name of the Credential. Changing this forces a new resource to be created.
    automation_account_name str
    The name of the automation account in which the Credential is created. Changing this forces a new resource to be created.
    password str
    The password associated with this Automation Credential.
    resource_group_name str
    The name of the resource group in which the Credential is created. Changing this forces a new resource to be created.
    username str
    The username associated with this Automation Credential.
    description str
    The description associated with this Automation Credential.
    name str
    Specifies the name of the Credential. Changing this forces a new resource to be created.
    automationAccountName String
    The name of the automation account in which the Credential is created. Changing this forces a new resource to be created.
    password String
    The password associated with this Automation Credential.
    resourceGroupName String
    The name of the resource group in which the Credential is created. Changing this forces a new resource to be created.
    username String
    The username associated with this Automation Credential.
    description String
    The description associated with this Automation Credential.
    name String
    Specifies the name of the Credential. Changing this forces a new resource to be created.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Credential resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Credential Resource

    Get an existing Credential resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: CredentialState, opts?: CustomResourceOptions): Credential
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        automation_account_name: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        password: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        username: Optional[str] = None) -> Credential
    func GetCredential(ctx *Context, name string, id IDInput, state *CredentialState, opts ...ResourceOption) (*Credential, error)
    public static Credential Get(string name, Input<string> id, CredentialState? state, CustomResourceOptions? opts = null)
    public static Credential get(String name, Output<String> id, CredentialState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AutomationAccountName string
    The name of the automation account in which the Credential is created. Changing this forces a new resource to be created.
    Description string
    The description associated with this Automation Credential.
    Name string
    Specifies the name of the Credential. Changing this forces a new resource to be created.
    Password string
    The password associated with this Automation Credential.
    ResourceGroupName string
    The name of the resource group in which the Credential is created. Changing this forces a new resource to be created.
    Username string
    The username associated with this Automation Credential.
    AutomationAccountName string
    The name of the automation account in which the Credential is created. Changing this forces a new resource to be created.
    Description string
    The description associated with this Automation Credential.
    Name string
    Specifies the name of the Credential. Changing this forces a new resource to be created.
    Password string
    The password associated with this Automation Credential.
    ResourceGroupName string
    The name of the resource group in which the Credential is created. Changing this forces a new resource to be created.
    Username string
    The username associated with this Automation Credential.
    automationAccountName String
    The name of the automation account in which the Credential is created. Changing this forces a new resource to be created.
    description String
    The description associated with this Automation Credential.
    name String
    Specifies the name of the Credential. Changing this forces a new resource to be created.
    password String
    The password associated with this Automation Credential.
    resourceGroupName String
    The name of the resource group in which the Credential is created. Changing this forces a new resource to be created.
    username String
    The username associated with this Automation Credential.
    automationAccountName string
    The name of the automation account in which the Credential is created. Changing this forces a new resource to be created.
    description string
    The description associated with this Automation Credential.
    name string
    Specifies the name of the Credential. Changing this forces a new resource to be created.
    password string
    The password associated with this Automation Credential.
    resourceGroupName string
    The name of the resource group in which the Credential is created. Changing this forces a new resource to be created.
    username string
    The username associated with this Automation Credential.
    automation_account_name str
    The name of the automation account in which the Credential is created. Changing this forces a new resource to be created.
    description str
    The description associated with this Automation Credential.
    name str
    Specifies the name of the Credential. Changing this forces a new resource to be created.
    password str
    The password associated with this Automation Credential.
    resource_group_name str
    The name of the resource group in which the Credential is created. Changing this forces a new resource to be created.
    username str
    The username associated with this Automation Credential.
    automationAccountName String
    The name of the automation account in which the Credential is created. Changing this forces a new resource to be created.
    description String
    The description associated with this Automation Credential.
    name String
    Specifies the name of the Credential. Changing this forces a new resource to be created.
    password String
    The password associated with this Automation Credential.
    resourceGroupName String
    The name of the resource group in which the Credential is created. Changing this forces a new resource to be created.
    username String
    The username associated with this Automation Credential.

    Import

    Automation Credentials can be imported using the resource id, e.g.

    $ pulumi import azure:automation/credential:Credential credential1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Automation/automationAccounts/account1/credentials/credential1

    To learn more about importing existing cloud resources, see Importing resources.

    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 v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-azure