Get information about a connection type

 

The Get information about a connection type operation gets the definition of a connection type.

To specify the request, replace <subscription-id> with your subscription ID, <cloud-service-name> with the name of the cloud service to use for making the request, <automation-account-name> with the name of the automation account to use for making the request, and <connection-type-name> with the name of the connection type to get information about. Include required URI parameters.

Method

Request URI

GET

https://management.core.windows.net/<subscription-id>/cloudServices/<cloud-service-name>/resources/automation/~/automationAccounts/<automation-account-name>/connectionTypes/<connection-type-name>?api-version=2014-12-08

Parameter

Description

api-version

Required. Must be set to 2014-12-08.

The request header in the following table is required.

Request Header

Description

x-ms-version

Specifies the version of the operation. Set to 2013-06-01 or a later version.

A successful operation returns 200 (OK). For information about common error codes, see HTTP/1.1 Status Code Definitions.

Request Header

Description

x-ms-request-id

A unique identifier for the current operation.

JSON
Copy 
{
   "name":"LitwareTwitter",
   "properties":{
      "isGlobal":false,
      "fieldDefinitions":{
         "Owner":{
            "isEncrypted":false,
            "isOptional":false,
            "type":"System.String"
         },
         "ConsuerAPIKey":{
            "isEncrypted":true,
            "isOptional":false,
            "type":"System.String"
         },
         "ConsuerAPISecret":{
            "isEncrypted":true,
            "isOptional":false,
            "type":"System.String"
         },
         "AccessToken":{
            "isEncrypted":true,
            "isOptional":false,
            "type":"System.String"
         },
         "AccessTokenSecret":{
            "isEncrypted":true,
            "isOptional":false,
            "type":"System.String"
         }
      },
      "creationTime":"2015-05-18T07:11:31.71+00:00",
      "lastModifiedTime":"2015-05-18T07:11:31.71+00:00"
   }
}

Element

Description

name

Name of the connection type.

isGlobal

Indicates whether the connection type is global.

fieldDefintions

The array of fields by their names.

fieldDefinitions/isEncrypted

true to specify that a connection’s value for this field should be encrypted false.

fieldDefinitions/isOptional

true to not require a value for this field in a connection; otherwise false.

fieldDefinitions/type

The field's data type. Must be one either System.String, System.In32, or System.Boolean.

creationTime

Date and time the connection type was created.

lastmodifiedTime

Date and time the connection type was last modified.

Show: