Connection
The Connection entity represents Service Management Automation connection. The Connections collection includes all of the connections in the local System Management Automation environment.
Inheritance Hierarchy
Orchestrator.ResourceModel
Connection
Supported HTTP Verbs
Create (POST) | Read (GET) | Update (PUT) | Delete (DELETE) |
---|---|---|---|
True |
True |
True |
True |
Entity Properties
For more information about how the properties of an entity interact with HTTP operations, see Service Management Automation Web Service Fundamentals.
Name | Create (PUT) | Read (GET) | Update (POST) | Delete (DELETE) | Type | Nullable | Description |
---|---|---|---|---|---|---|---|
ConnectionID |
- |
Required* |
Required |
Required |
Edm.Guid |
False |
Key Property The unique identifier of the connection. |
ConnectionTypeID |
Required |
- |
- |
- |
Edm.Guid |
False |
The unique identifier of the connection type. |
CreationTime |
- |
- |
- |
- |
Edm.DateTime |
False |
The date and time the connection was created. |
Description |
- |
- |
- |
- |
Edm.String |
True |
The description of the connection. |
LastModifiedTime |
- |
- |
- |
- |
Edm.DateTime |
False |
The date and time the connection was last modified. |
Name |
Required |
- |
- |
- |
Edm.String |
False |
The name of the connection. The connection name needs to be unique when creating a new connection instance. |
TenantID |
- |
- |
- |
- |
Edm.Guid |
False |
The unique identifier of the tenant that manages the Service Management Automation service. |
Note
- Direct access to the entity requires the key property ConnectionID. This property is not required to simply enumerate the Connections collection.
Relationships
For more information about how the relationships of an entity are used, see Service Management Automation Web Service Fundamentals.
Name | Relationship Type | From Property | To Entity | To Property |
---|---|---|---|---|
ConnectionFieldValues |
Many |
ConnectionID |
ConnectionFieldValue |
ConnectionID |
ConnectionType |
One |
ConnectionTypeID |
ConnectionType |
ConnectionTypeID |
Examples
Examples of supported data operations are available in the Connections collection topic.