Automation Account - Create Or Update

Service:

Automation

API Version:

2021-06-22

Create or update automation account.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}?api-version=2021-06-22

URI Parameters

Name	In	Required	Type	Description
automationAccountName	path	True	string	The name of the automation account.
resourceGroupName	path	True	string	Name of an Azure Resource group. Regex pattern: ^[-\w\._]+$
subscriptionId	path	True	string	Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Client Api Version.

Request Body

Name	Type	Description
identity	Identity	Sets the identity property for automation account
location	string	Gets or sets the location of the resource.
name	string	Gets or sets name of the resource.
properties.disableLocalAuth	boolean	Indicates whether requests using non-AAD authentication are blocked
properties.encryption	EncryptionProperties	Set the encryption properties for the automation account
properties.publicNetworkAccess	boolean	Indicates whether traffic on the non-ARM endpoint (Webhook/Agent) is allowed from the public internet
properties.sku	Sku	Gets or sets account SKU.
tags	object	Gets or sets the tags attached to the resource.

Responses

Name	Type	Description
200 OK	AutomationAccount	OK
201 Created	AutomationAccount	Created
Other Status Codes	ErrorResponse	Automation error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Create or update automation account

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount9?api-version=2021-06-22

{
  "properties": {
    "sku": {
      "name": "Free"
    }
  },
  "name": "myAutomationAccount9",
  "location": "East US 2"
}

Java

import com.azure.resourcemanager.automation.models.Sku;
import com.azure.resourcemanager.automation.models.SkuNameEnum;

/** Samples for AutomationAccount CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/automation/resource-manager/Microsoft.Automation/stable/2021-06-22/examples/createOrUpdateAutomationAccount.json
     */
    /**
     * Sample code: Create or update automation account.
     *
     * @param manager Entry point to AutomationManager.
     */
    public static void createOrUpdateAutomationAccount(com.azure.resourcemanager.automation.AutomationManager manager) {
        manager
            .automationAccounts()
            .define("myAutomationAccount9")
            .withExistingResourceGroup("rg")
            .withRegion("East US 2")
            .withName("myAutomationAccount9")
            .withSku(new Sku().withName(SkuNameEnum.FREE))
            .create();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armautomation_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/main/specification/automation/resource-manager/Microsoft.Automation/stable/2021-06-22/examples/createOrUpdateAutomationAccount.json
func ExampleAccountClient_CreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armautomation.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAccountClient().CreateOrUpdate(ctx, "rg", "myAutomationAccount9", armautomation.AccountCreateOrUpdateParameters{
		Name:     to.Ptr("myAutomationAccount9"),
		Location: to.Ptr("East US 2"),
		Properties: &armautomation.AccountCreateOrUpdateProperties{
			SKU: &armautomation.SKU{
				Name: to.Ptr(armautomation.SKUNameEnumFree),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Account = armautomation.Account{
	// 	Name: to.Ptr("ContoseAutomationAccount"),
	// 	Type: to.Ptr("Microsoft.Automation/AutomationAccounts"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount9"),
	// 	Location: to.Ptr("East US 2"),
	// 	Tags: map[string]*string{
	// 	},
	// 	Properties: &armautomation.AccountProperties{
	// 		CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-03-28T18:21:15.187+00:00"); return t}()),
	// 		LastModifiedBy: to.Ptr("myEmaild@microsoft.com"),
	// 		LastModifiedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-03-28T18:21:15.187+00:00"); return t}()),
	// 		SKU: &armautomation.SKU{
	// 			Name: to.Ptr(armautomation.SKUNameEnumFree),
	// 		},
	// 		State: to.Ptr(armautomation.AutomationAccountStateOk),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { AutomationClient } = require("@azure/arm-automation");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Create or update automation account.
 *
 * @summary Create or update automation account.
 * x-ms-original-file: specification/automation/resource-manager/Microsoft.Automation/stable/2021-06-22/examples/createOrUpdateAutomationAccount.json
 */
async function createOrUpdateAutomationAccount() {
  const subscriptionId = process.env["AUTOMATION_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["AUTOMATION_RESOURCE_GROUP"] || "rg";
  const automationAccountName = "myAutomationAccount9";
  const parameters = {
    name: "myAutomationAccount9",
    location: "East US 2",
    sku: { name: "Free" },
  };
  const credential = new DefaultAzureCredential();
  const client = new AutomationClient(credential, subscriptionId);
  const result = await client.automationAccountOperations.createOrUpdate(
    resourceGroupName,
    automationAccountName,
    parameters
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Automation;
using Azure.ResourceManager.Automation.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/automation/resource-manager/Microsoft.Automation/stable/2021-06-22/examples/createOrUpdateAutomationAccount.json
// this example is just showing the usage of "AutomationAccount_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "subid";
string resourceGroupName = "rg";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this AutomationAccountResource
AutomationAccountCollection collection = resourceGroupResource.GetAutomationAccounts();

// invoke the operation
string automationAccountName = "myAutomationAccount9";
AutomationAccountCreateOrUpdateContent content = new AutomationAccountCreateOrUpdateContent()
{
    Name = "myAutomationAccount9",
    Location = new AzureLocation("East US 2"),
    Sku = new AutomationSku(AutomationSkuName.Free),
};
ArmOperation<AutomationAccountResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, automationAccountName, content);
AutomationAccountResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
AutomationAccountData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

201

{
  "name": "myAutomationAccount9",
  "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount9",
  "type": "Microsoft.Automation/AutomationAccounts",
  "location": "East US 2",
  "tags": {},
  "etag": null,
  "properties": {
    "sku": {
      "name": "Free",
      "family": null,
      "capacity": null
    },
    "state": "Ok",
    "creationTime": "2017-03-26T01:13:43.267+00:00",
    "lastModifiedBy": "myEmailId@microsoft.com",
    "lastModifiedTime": "2017-03-26T01:13:43.267+00:00"
  }
}

Status code:

200

{
  "name": "ContoseAutomationAccount",
  "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount9",
  "type": "Microsoft.Automation/AutomationAccounts",
  "location": "East US 2",
  "tags": {},
  "etag": null,
  "properties": {
    "sku": {
      "name": "Free",
      "family": null,
      "capacity": null
    },
    "state": "Ok",
    "creationTime": "2017-03-28T18:21:15.187+00:00",
    "lastModifiedBy": "myEmaild@microsoft.com",
    "lastModifiedTime": "2017-03-28T18:21:15.187+00:00"
  }
}

Definitions

Name	Description
AutomationAccount	Definition of the automation account type.
AutomationAccountCreateOrUpdateParameters	The parameters supplied to the create or update automation account operation.
AutomationAccountState	Gets status of account.
createdByType	The type of identity that created the resource.
EncryptionKeySourceType	Encryption Key Source
EncryptionProperties	The encryption settings for automation account
ErrorResponse	Error response of an operation failure
Identity	Identity for the resource.
KeyVaultProperties	Settings concerning key vault encryption for a configuration store.
PrivateEndpointConnection	A private endpoint connection
PrivateEndpointProperty	Private endpoint which the connection belongs to.
PrivateLinkServiceConnectionStateProperty	Connection State of the Private Endpoint Connection.
ResourceIdentityType	The identity type.
Sku	The account SKU.
SkuNameEnum	Gets or sets the SKU name of the account.
systemData	Metadata pertaining to creation and last modification of the resource.
UserAssignedIdentities	The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

AutomationAccount

Definition of the automation account type.

Name	Type	Description
etag	string	Gets or sets the etag of the resource.
id	string	Fully qualified resource Id for the resource
identity	Identity	Identity for the resource.
location	string	The Azure Region where the resource lives
name	string	The name of the resource
properties.automationHybridServiceUrl	string	URL of automation hybrid service which is used for hybrid worker on-boarding.
properties.creationTime	string	Gets the creation time.
properties.description	string	Gets or sets the description.
properties.disableLocalAuth	boolean	Indicates whether requests using non-AAD authentication are blocked
properties.encryption	EncryptionProperties	Encryption properties for the automation account
properties.lastModifiedBy	string	Gets or sets the last modified by.
properties.lastModifiedTime	string	Gets the last modified time.
properties.privateEndpointConnections	PrivateEndpointConnection[]	List of Automation operations supported by the Automation resource provider.
properties.publicNetworkAccess	boolean	Indicates whether traffic on the non-ARM endpoint (Webhook/Agent) is allowed from the public internet
properties.sku	Sku	Gets or sets the SKU of account.
properties.state	AutomationAccountState	Gets status of account.
systemData	systemData	Resource system metadata.
tags	object	Resource tags.
type	string	The type of the resource.

AutomationAccountCreateOrUpdateParameters

The parameters supplied to the create or update automation account operation.

Name	Type	Description
identity	Identity	Sets the identity property for automation account
location	string	Gets or sets the location of the resource.
name	string	Gets or sets name of the resource.
properties.disableLocalAuth	boolean	Indicates whether requests using non-AAD authentication are blocked
properties.encryption	EncryptionProperties	Set the encryption properties for the automation account
properties.publicNetworkAccess	boolean	Indicates whether traffic on the non-ARM endpoint (Webhook/Agent) is allowed from the public internet
properties.sku	Sku	Gets or sets account SKU.
tags	object	Gets or sets the tags attached to the resource.

AutomationAccountState

Gets status of account.

Name	Type	Description
Ok	string
Suspended	string
Unavailable	string

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

EncryptionKeySourceType

Encryption Key Source

Name	Type	Description
Microsoft.Automation	string
Microsoft.Keyvault	string

EncryptionProperties

The encryption settings for automation account

Name	Type	Description
identity	Identity	User identity used for CMK.
keySource	EncryptionKeySourceType	Encryption Key Source
keyVaultProperties	KeyVaultProperties	Key vault properties.

ErrorResponse

Error response of an operation failure

Name	Type	Description
code	string	Error code
message	string	Error message indicating why the operation failed.

Identity

Identity for the resource.

Name	Type	Description
principalId	string	The principal ID of resource identity.
tenantId	string	The tenant ID of resource.
type	ResourceIdentityType	The identity type.
userAssignedIdentities	UserAssignedIdentities	The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

KeyVaultProperties

Settings concerning key vault encryption for a configuration store.

Name	Type	Description
keyName	string	The name of key used to encrypt data.
keyVersion	string	The key version of the key used to encrypt data.
keyvaultUri	string	The URI of the key vault key used to encrypt data.

PrivateEndpointConnection

A private endpoint connection

Name	Type	Description
id	string	Fully qualified resource Id for the resource
name	string	The name of the resource
properties.groupIds	string[]	Gets the groupIds.
properties.privateEndpoint	PrivateEndpointProperty	Private endpoint which the connection belongs to.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	Connection State of the Private Endpoint Connection.
type	string	The type of the resource.

PrivateEndpointProperty

Private endpoint which the connection belongs to.

Name	Type	Description
id	string	Resource id of the private endpoint.

PrivateLinkServiceConnectionStateProperty

Connection State of the Private Endpoint Connection.

Name	Type	Description
actionsRequired	string	Any action that is required beyond basic workflow (approve/ reject/ disconnect)
description	string	The private link service connection description.
status	string	The private link service connection status.

ResourceIdentityType

The identity type.

Name	Type	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

Sku

The account SKU.

Name	Type	Description
capacity	integer	Gets or sets the SKU capacity.
family	string	Gets or sets the SKU family.
name	SkuNameEnum	Gets or sets the SKU name of the account.

SkuNameEnum

Gets or sets the SKU name of the account.

Name	Type	Description
Basic	string
Free	string

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

UserAssignedIdentities

The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

Name	Type	Description