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 pattern: ^[-\w\._]+$	Name of an Azure Resource group.
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.
variableName	path	True	string	The variable name.
api-version	query	True	string	Client Api Version.

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	OK
201 Created	Variable	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 a variable

Sample request

HTTP

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

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

Sample response

Status code:

201

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

Status code:

200

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

Definitions

Name	Description
createdByType	The type of identity that created the resource.
ErrorResponse	Error response of an operation failure
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

ErrorResponse

Object

Error response of an operation failure

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

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.