Connection Type - Create Or Update

Create a connectiontype.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/connectionTypes/{connectionTypeName}?api-version=2015-10-31

URI Parameters

Name In Required Type Description
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.

resourceGroupName
path True
  • string

Name of an Azure Resource group.

Regex pattern: ^[-\w\._]+$

automationAccountName
path True
  • string

The name of the automation account.

connectionTypeName
path True
  • string

The parameters supplied to the create or update connectiontype operation.

api-version
query True
  • string

Client Api Version.

Request Body

Name Required Type Description
name True
  • string

Gets or sets the name of the connection type.

properties.fieldDefinitions True

Gets or sets the field definitions of the connection type.

properties.isGlobal
  • boolean

Gets or sets a Boolean value to indicate if the connection type is global.

Responses

Name Type Description
201 Created

Created

Other Status Codes

Conflict

Other Status Codes

Automation error response describing why the operation failed.

Examples

Create or update connection type

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount22/connectionTypes/myCT?api-version=2015-10-31
{
  "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"
      }
    }
  }
}

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.433+00:00"
  }
}

Definitions

ConnectionType

Definition of the connection type.

ConnectionTypeCreateOrUpdateParameters

The parameters supplied to the create or update connection type operation.

ErrorResponse

Error response of an operation failure

FieldDefinition

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

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

ConnectionTypeCreateOrUpdateParameters

The parameters supplied to the create or update connection type operation.

Name Type Description
name
  • string

Gets or sets the name of the connection type.

properties.fieldDefinitions

Gets or sets the field definitions of the connection type.

properties.isGlobal
  • boolean

Gets or sets a Boolean value to indicate if the connection type is global.

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.