Azure Automation Variable API
The Variable API from Azure Automation — 2 operation(s) for variable.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/microsoft-azure-automation:microsoft-azure-automation-variable-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Microsoft Azure Automation Variable API
version: '2024-10-23'
x-typespec-generated:
- emitter: '@azure-tools/typespec-autorest'
description: 'Operations tagged Variable across 2 of this provider''s published API definitions: microsoft-azure-automation-openapi.json, microsoft-azure-automation-management-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://management.azure.com
security:
- azure_auth:
- user_impersonation
tags:
- name: Variable
paths:
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/variables
: get:
operationId: Variable_ListByAutomationAccount
tags:
- Variable
description: Retrieve a list of variables.
externalDocs:
url: http://aka.ms/azureautomationsdk/variableoperations
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: automationAccountName
in: path
description: The name of the automation account.
required: true
schema:
type: string
responses:
'200':
description: Azure operation completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/VariableListResult'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
List variables, First 100:
$ref: ./examples/listVariables_First100.json
List variables, Next 100:
$ref: ./examples/listVariables_Next100.json
x-ms-pageable:
nextLinkName: nextLink
summary: Variable list by automation account
x-summary-source: derived
servers:
- url: https://management.azure.com
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/variables/{variableName}
: get:
operationId: Variable_Get
tags:
- Variable
description: Retrieve the variable identified by variable name.
externalDocs:
url: http://aka.ms/azureautomationsdk/variableoperations
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: automationAccountName
in: path
description: The name of the automation account.
required: true
schema:
type: string
- name: variableName
in: path
description: The name of variable.
required: true
schema:
type: string
responses:
'200':
description: Azure operation completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Variable'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
Get a variable:
$ref: ./examples/getVariable.json
summary: Variable get
x-summary-source: derived
put:
operationId: Variable_CreateOrUpdate
tags:
- Variable
description: Create a variable.
externalDocs:
url: http://aka.ms/azureautomationsdk/variableoperations
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: automationAccountName
in: path
description: The name of the automation account.
required: true
schema:
type: string
- name: variableName
in: path
description: The name of variable.
required: true
schema:
type: string
responses:
'200':
description: Resource 'Variable' update operation succeeded
content:
application/json:
schema:
$ref: '#/components/schemas/Variable'
'201':
description: Resource 'Variable' create operation succeeded
content:
application/json:
schema:
$ref: '#/components/schemas/Variable'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
Create or update a variable:
$ref: ./examples/createOrUpdateVariable.json
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/VariableCreateOrUpdateParameters'
description: The parameters supplied to the create or update variable operation.
required: true
summary: Variable create or update
x-summary-source: derived
patch:
operationId: Variable_Update
tags:
- Variable
description: Update a variable.
externalDocs:
url: http://aka.ms/azureautomationsdk/variableoperations
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: automationAccountName
in: path
description: The name of the automation account.
required: true
schema:
type: string
- name: variableName
in: path
description: The name of variable.
required: true
schema:
type: string
responses:
'200':
description: Azure operation completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Variable'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
Update a variable:
$ref: ./examples/updateVariable_patch.json
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/VariableUpdateParameters'
description: The parameters supplied to the update variable operation.
required: true
summary: Variable update
x-summary-source: derived
delete:
operationId: Variable_Delete
tags:
- Variable
description: Delete the variable.
externalDocs:
url: http://aka.ms/azureautomationsdk/variableoperations
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: automationAccountName
in: path
description: The name of the automation account.
required: true
schema:
type: string
- name: variableName
in: path
description: The name of variable.
required: true
schema:
type: string
responses:
'200':
description: Resource deleted successfully.
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
Delete a variable:
$ref: ./examples/deleteVariable.json
summary: Variable delete
x-summary-source: derived
servers:
- url: https://management.azure.com
components:
schemas:
VariableCreateOrUpdateProperties:
type: object
description: The properties of the create variable operation.
properties:
value:
type: string
description: Gets or sets the value of the variable.
description:
type: string
description: Gets or sets the description of the variable.
isEncrypted:
type: boolean
description: Gets or sets the encrypted flag of the variable.
VariableUpdateProperties:
type: object
description: The properties of the update variable
properties:
value:
type: string
description: Gets or sets the value of the variable.
description:
type: string
description: Gets or sets the description of the variable.
VariableProperties:
type: object
description: Definition of the variable properties
properties:
value:
type: string
description: Gets or sets the value of the variable.
isEncrypted:
type:
- boolean
- 'null'
description: Gets or sets the encrypted flag of the variable.
creationTime:
type: string
format: date-time
description: Gets or sets the creation time.
lastModifiedTime:
type: string
format: date-time
description: Gets or sets the last modified time.
description:
type: string
description: Gets or sets the description.
VariableListResult:
type: object
description: The response of a Variable list operation.
properties:
value:
type: array
description: The Variable items on this page
items:
$ref: '#/components/schemas/Variable'
nextLink:
type: string
format: uri
description: The link to the next page of items
required:
- value
VariableUpdateParameters:
type: object
description: The parameters supplied to the update variable operation.
properties:
name:
type: string
description: Gets or sets the name of the variable.
properties:
$ref: '#/components/schemas/VariableUpdateProperties'
description: Gets or sets the value of the variable.
x-ms-client-flatten: true
Variable:
type: object
description: Definition of the variable.
properties:
properties:
$ref: '#/components/schemas/VariableProperties'
description: Gets or sets the properties of the variable.
x-ms-client-flatten: true
allOf:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
VariableCreateOrUpdateParameters:
type: object
description: The parameters supplied to the create or update variable operation.
properties:
name:
type: string
description: Gets or sets the name of the variable.
properties:
$ref: '#/components/schemas/VariableCreateOrUpdateProperties'
description: Gets or sets the properties of the variable.
x-ms-client-flatten: true
required:
- name
- properties
securitySchemes:
azure_auth:
type: oauth2
flows:
implicit:
scopes:
user_impersonation: impersonate your user account
authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
description: Azure Active Directory OAuth2 Flow.
x-refined-from:
- microsoft-azure-automation-openapi.json
- microsoft-azure-automation-management-openapi.yml