Share via

ConnectionFieldValue

  • Article

The ConnectionFieldValue entity represents the value of a System Management Automation connection field. The ConnectionFieldValues collection includes all of the connection field values in the local System Management Automation environment.

Inheritance Hierarchy

Orchestrator.ResourceModel
  ConnectionFieldValue

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

ConnectionFieldValueID

            -

      Optional*

      Required

      Required

Edm.Guid

False

Key Property

The unique identifier of the connection field value.

ConnectionFieldID

            -

      Optional

            -

            -

Edm.Guid

False

The unique identifier of the connection field.

ConnectionFieldName

            -

      Optional

            -

            -

Edm.String

True

The name of the connection field.

ConnectionID

            -

      Optional

            -

            -

Edm.Guid

False

The unique identifier of the connection.

ConnectionName

            -

      Optional

            -

            -

Edm.String

True

The name of the connection.

ConnectionTypeID

            -

      Optional

            -

            -

Edm.Guid

False

Unique identifier of the connection type.

ConnectionTypeName

            -

      Optional

            -

            -

Edm.String

True

The name of the connection type.

CreationTime

            -

      Optional

            -

            -

Edm.DateTime

False

The date and time the connection field value was created.

IsEncrypted

            -

      Optional

            -

            -

Edm.Boolean

False

Indicates whether the connection field value is encrypted.

IsOptional

            -

      Optional

            -

            -

Edm.Boolean

True

Indicates whether the connection field value is required when creating a connection.

LastModifiedTime

            -

      Optional

            -

            -

Edm.DateTime

False

Indicates the date and time the connection field value was last updated.

TenantID

            -

      Optional

            -

            -

Edm.Guid

False

The unique identifier of the tenant that manages the System Management Automation service.

Type

            -

      Optional

            -

            -

Edm.String

True

The type of the connection field value.

Value

            -

      Optional

            -

            -

Edm.String

True

The value of connection field.

 

Note

  • Direct access to the entity requires the key property ConnectionFieldValueID. This property is not required to simply enumerate the ConnectionFieldValues 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

Connection

One

ConnectionID

Connection

ConnectionID

Examples

Examples of supported data operations are available in the ConnectionFieldValues collection topic.

See Also

Concepts

ConnectionFieldValues