Azure Automation Connection API
The Connection API from Azure Automation — 2 operation(s) for connection.
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-connection-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 Connection API
version: '2024-10-23'
x-typespec-generated:
- emitter: '@azure-tools/typespec-autorest'
description: 'Operations tagged Connection 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: Connection
paths:
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/connections
: get:
operationId: Connection_ListByAutomationAccount
tags:
- Connection
description: Retrieve a list of connections.
externalDocs:
url: http://aka.ms/azureautomationsdk/connectionoperations
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/ConnectionListResult'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
List connections by automation account, first 100:
$ref: ./examples/listConnectionsByAutomationAccount_First100.json
List connections by automation account, next 100:
$ref: ./examples/listConnectionsByAutomationAccount_Next100.json
x-ms-pageable:
nextLinkName: nextLink
summary: Connection list by automation account
x-summary-source: derived
servers:
- url: https://management.azure.com
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/connections/{connectionName}
: get:
operationId: Connection_Get
tags:
- Connection
description: Retrieve the connection identified by connection name.
externalDocs:
url: http://aka.ms/azureautomationsdk/connectionoperations
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: connectionName
in: path
description: The name of connection.
required: true
schema:
type: string
responses:
'200':
description: Azure operation completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Connection'
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 connection:
$ref: ./examples/getConnection.json
summary: Connection get
x-summary-source: derived
put:
operationId: Connection_CreateOrUpdate
tags:
- Connection
description: Create or update a connection.
externalDocs:
url: http://aka.ms/azureautomationsdk/connectionoperations
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: connectionName
in: path
description: The name of connection.
required: true
schema:
type: string
responses:
'200':
description: Resource 'Connection' update operation succeeded
content:
application/json:
schema:
$ref: '#/components/schemas/Connection'
'201':
description: Resource 'Connection' create operation succeeded
content:
application/json:
schema:
$ref: '#/components/schemas/Connection'
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 connection:
$ref: ./examples/createOrUpdateConnection.json
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectionCreateOrUpdateParameters'
description: The parameters supplied to the create or update connection operation.
required: true
summary: Connection create or update
x-summary-source: derived
patch:
operationId: Connection_Update
tags:
- Connection
description: Update a connection.
externalDocs:
url: http://aka.ms/azureautomationsdk/connectionoperations
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: connectionName
in: path
description: The name of connection.
required: true
schema:
type: string
responses:
'200':
description: Azure operation completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Connection'
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 connection:
$ref: ./examples/updateConnection.json
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectionUpdateParameters'
description: The parameters supplied to the update a connection operation.
required: true
summary: Connection update
x-summary-source: derived
delete:
operationId: Connection_Delete
tags:
- Connection
description: Delete the connection.
externalDocs:
url: http://aka.ms/azureautomationsdk/connectionoperations
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: connectionName
in: path
description: The name of connection.
required: true
schema:
type: string
responses:
'200':
description: Resource deleted successfully.
'204':
description: Resource does not exist.
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
Delete an existing connection:
$ref: ./examples/deleteConnection.json
summary: Connection delete
x-summary-source: derived
servers:
- url: https://management.azure.com
components:
schemas:
ConnectionUpdateProperties:
type: object
description: The properties of the update connection operation.
properties:
description:
type: string
description: Gets or sets the description of the connection.
fieldDefinitionValues:
type: object
description: Gets or sets the field definition values of the connection.
additionalProperties:
type: string
ConnectionProperties:
type: object
description: Definition of the connection properties.
properties:
connectionType:
$ref: '#/components/schemas/ConnectionTypeAssociationProperty'
description: Gets or sets the connectionType of the connection.
fieldDefinitionValues:
type: object
description: Gets the field definition values of the connection.
additionalProperties:
type: string
readOnly: true
creationTime:
type: string
format: date-time
description: Gets the creation time.
readOnly: true
lastModifiedTime:
type: string
format: date-time
description: Gets the last modified time.
readOnly: true
description:
type: string
description: Gets or sets the description.
ConnectionUpdateParameters:
type: object
description: The parameters supplied to the update connection operation.
properties:
name:
type: string
description: Gets or sets the name of the connection.
properties:
$ref: '#/components/schemas/ConnectionUpdateProperties'
description: Gets or sets the properties of the connection.
x-ms-client-flatten: true
ConnectionCreateOrUpdateProperties:
type: object
description: The properties of the create connection properties
properties:
description:
type: string
description: Gets or sets the description of the connection.
connectionType:
$ref: '#/components/schemas/ConnectionTypeAssociationProperty'
description: Gets or sets the connectionType of the connection.
fieldDefinitionValues:
type: object
description: Gets or sets the field definition properties of the connection.
additionalProperties:
type: string
required:
- connectionType
ConnectionTypeAssociationProperty:
type: object
description: The connection type property associated with the entity.
properties:
name:
type: string
description: Gets or sets the name of the connection type.
ConnectionCreateOrUpdateParameters:
type: object
description: The parameters supplied to the create or update connection operation.
properties:
name:
type: string
description: Gets or sets the name of the connection.
properties:
$ref: '#/components/schemas/ConnectionCreateOrUpdateProperties'
description: Gets or sets the properties of the connection.
x-ms-client-flatten: true
required:
- name
- properties
Connection:
type: object
description: Definition of the connection.
properties:
properties:
$ref: '#/components/schemas/ConnectionProperties'
description: Gets or sets the properties of the connection.
x-ms-client-flatten: true
allOf:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
ConnectionListResult:
type: object
description: The response of a Connection list operation.
properties:
value:
type: array
description: The Connection items on this page
items:
$ref: '#/components/schemas/Connection'
nextLink:
type: string
format: uri
description: The link to the next page of items
required:
- value
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