Connection - Get

Service:

Automation

API Version:

2024-10-23

Retrieve the connection identified by connection name.

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

URI Parameters

Name	In	Required	Type	Description
automationAccountName	path	True	string	The name of the automation account.
connectionName	path	True	string	The name of connection.
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.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	Connection	Azure operation completed successfully.
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

Get a connection

Sample request

HTTP

GET https://management.azure.com/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount28/connections/myConnection?api-version=2024-10-23

Sample response

Status code:

200

{
  "name": "myConnection",
  "id": "/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount28/connections/myConnection",
  "properties": {
    "description": "my description goes here",
    "connectionType": {
      "name": "Azure"
    },
    "creationTime": "2017-03-27T07:52:29.29+00:00",
    "fieldDefinitionValues": {
      "AutomationCertificateName": "myCertificateName",
      "SubscriptionID": "b5e4748c-f69a-467c-8749-e2f9c8cd3007"
    },
    "lastModifiedTime": "2017-03-27T07:52:33.617+00:00"
  }
}

Definitions

Name	Description
Connection	Definition of the connection.
ConnectionTypeAssociationProperty	The connection type property associated with the entity.
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.

Connection

Object

Definition of the connection.

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.connectionType	ConnectionTypeAssociationProperty	Gets or sets the connectionType of the connection.
properties.creationTime	string (date-time)	Gets the creation time.
properties.description	string	Gets or sets the description.
properties.fieldDefinitionValues	object	Gets the field definition values of the connection.
properties.lastModifiedTime	string (date-time)	Gets the last modified time.
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"

ConnectionTypeAssociationProperty

Object

The connection type property associated with the entity.

Name	Type	Description
name	string	Gets or sets the name of the connection type.

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.