Variable - Create Or Update

Service:

Automation

API Version:

2024-10-23

Create a variable.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/variables/{variableName}?api-version=2024-10-23

URI Parameters

Name	In	Required	Type	Description
automationAccountName	path	True	string	The name of the automation account.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
variableName	path	True	string	The name of variable.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Required	Type	Description
name	True	string	Gets or sets the name of the variable.
properties.description		string	Gets or sets the description of the variable.
properties.isEncrypted		boolean	Gets or sets the encrypted flag of the variable.
properties.value		string	Gets or sets the value of the variable.

Responses

Name	Type	Description
200 OK	Variable	Resource 'Variable' update operation succeeded
201 Created	Variable	Resource 'Variable' create operation succeeded
Other Status Codes	ErrorResponse	An unexpected error response.

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 a variable

Sample request

HTTP

PUT https://management.azure.com/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/sampleAccount9/variables/sampleVariable?api-version=2024-10-23

{
  "name": "sampleVariable",
  "properties": {
    "description": "my description",
    "isEncrypted": false,
    "value": "\"ComputerName.domain.com\""
  }
}

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.automation import AutomationClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-automation
# USAGE
    python create_or_update_variable.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = AutomationClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.variable.create_or_update(
        resource_group_name="rg",
        automation_account_name="sampleAccount9",
        variable_name="sampleVariable",
        parameters={
            "name": "sampleVariable",
            "properties": {"description": "my description", "isEncrypted": False, "value": '"ComputerName.domain.com"'},
        },
    )
    print(response)


# x-ms-original-file: 2024-10-23/createOrUpdateVariable.json
if __name__ == "__main__":
    main()

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: 2024-10-23/createOrUpdateVariable.json
func ExampleVariableClient_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("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewVariableClient().CreateOrUpdate(ctx, "rg", "sampleAccount9", "sampleVariable", armautomation.VariableCreateOrUpdateParameters{
		Name: to.Ptr("sampleVariable"),
		Properties: &armautomation.VariableCreateOrUpdateProperties{
			Description: to.Ptr("my description"),
			IsEncrypted: to.Ptr(false),
			Value:       to.Ptr("\"ComputerName.domain.com\""),
		},
	}, 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 = armautomation.VariableClientCreateOrUpdateResponse{
	// 	Variable: armautomation.Variable{
	// 		Name: to.Ptr("sampleVariable"),
	// 		ID: to.Ptr("/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/sampleAccount9/variables/sampleVariable"),
	// 		Properties: &armautomation.VariableProperties{
	// 			Description: to.Ptr("my description"),
	// 			CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-03-28T22:59:00.937+00:00"); return t}()),
	// 			IsEncrypted: to.Ptr(false),
	// 			LastModifiedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-03-28T22:59:00.937+00:00"); return t}()),
	// 			Value: to.Ptr("\"ComputerName2.domain.com\""),
	// 		},
	// 	},
	// }
}

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 a variable.
 *
 * @summary create a variable.
 * x-ms-original-file: 2024-10-23/createOrUpdateVariable.json
 */
async function createOrUpdateAVariable() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee";
  const client = new AutomationClient(credential, subscriptionId);
  const result = await client.variableOperations.createOrUpdate(
    "rg",
    "sampleAccount9",
    "sampleVariable",
    {
      name: "sampleVariable",
      description: "my description",
      isEncrypted: false,
      value: '"ComputerName.domain.com"',
    },
  );
  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

Sample response

Status code:

200

{
  "name": "sampleVariable",
  "id": "/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/sampleAccount9/variables/sampleVariable",
  "properties": {
    "description": "my description",
    "creationTime": "2017-03-28T22:59:00.937+00:00",
    "isEncrypted": false,
    "lastModifiedTime": "2017-03-28T22:59:00.937+00:00",
    "value": "\"ComputerName2.domain.com\""
  }
}

Status code:

201

{
  "name": "sampleVariable",
  "id": "/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/sampleAccount9/variables/sampleVariable",
  "properties": {
    "description": "my description",
    "creationTime": "2017-03-28T22:59:00.937+00:00",
    "isEncrypted": false,
    "lastModifiedTime": "2017-03-28T22:59:00.937+00:00",
    "value": "\"ComputerName.domain.com\""
  }
}

Definitions

Name	Description
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
systemData	Metadata pertaining to creation and last modification of the resource.
Variable	Definition of the variable.
VariableCreateOrUpdateParameters	The parameters supplied to the create or update variable operation.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	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 (date-time)	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.

Variable

Object

Definition of the variable.

Name	Type	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties.creationTime	string (date-time)	Gets or sets the creation time.
properties.description	string	Gets or sets the description.
properties.isEncrypted	boolean	Gets or sets the encrypted flag of the variable.
properties.lastModifiedTime	string (date-time)	Gets or sets the last modified time.
properties.value	string	Gets or sets the value of the variable.
systemData	systemData	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"

VariableCreateOrUpdateParameters

Object

The parameters supplied to the create or update variable operation.

Name	Type	Description
name	string	Gets or sets the name of the variable.
properties.description	string	Gets or sets the description of the variable.
properties.isEncrypted	boolean	Gets or sets the encrypted flag of the variable.
properties.value	string	Gets or sets the value of the variable.