Connection Type - Get
Retrieve the connection type identified by connection type name.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/connectionTypes/{connectionTypeName}?api-version=2023-11-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
automation
|
path | True |
string |
The name of the automation account. |
connection
|
path | True |
string |
The name of connection type. |
resource
|
path | True |
string |
Name of an Azure Resource group. Regex pattern: |
subscription
|
path | True |
string |
Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
api-version
|
query | True |
string |
Client Api Version. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
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
Get connection type
Sample Request
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount22/connectionTypes/myCT?api-version=2023-11-01
Sample Response
{
"id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount22/connectionTypes/myCT",
"name": "myCT",
"properties": {
"isGlobal": false,
"fieldDefinitions": {
"myStringField": {
"isEncrypted": false,
"isOptional": false,
"type": "string"
},
"myBoolField": {
"isEncrypted": false,
"isOptional": false,
"type": "bool"
},
"myStringFieldEncrypted": {
"isEncrypted": true,
"isOptional": false,
"type": "string"
}
},
"creationTime": "2017-03-27T03:47:53.433+00:00",
"lastModifiedTime": "2017-03-27T03:47:53.557+00:00"
}
}
Definitions
Name | Description |
---|---|
Connection |
Definition of the connection type. |
Error |
Error response of an operation failure |
Field |
Definition of the connection fields. |
ConnectionType
Definition of the connection type.
Name | Type | Description |
---|---|---|
id |
string |
Gets the id of the resource. |
name |
string |
Gets the name of the connection type. |
properties.creationTime |
string |
Gets the creation time. |
properties.description |
string |
Gets or sets the description. |
properties.fieldDefinitions |
<string,
Field |
Gets the field definitions of the connection type. |
properties.isGlobal |
boolean |
Gets or sets a Boolean value to indicate if the connection type is global. |
properties.lastModifiedTime |
string |
Gets or sets the last modified time. |
type |
string |
Resource type |
ErrorResponse
Error response of an operation failure
Name | Type | Description |
---|---|---|
code |
string |
Error code |
message |
string |
Error message indicating why the operation failed. |
FieldDefinition
Definition of the connection fields.
Name | Type | Description |
---|---|---|
isEncrypted |
boolean |
Gets or sets the isEncrypted flag of the connection field definition. |
isOptional |
boolean |
Gets or sets the isOptional flag of the connection field definition. |
type |
string |
Gets or sets the type of the connection field definition. |