Share via


Variable

The Variable entity represents a variable in System Management Automation. The Variables collection includes all of the variables in the local System Management Automation environment.

Inheritance Hierarchy

Orchestrator.ResourceModel
  Variable

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

VariableID

            -

      Optional*

      Required

      Required

Edm.Guid

False

Key Property

The unique identifier of the value.

CreationTime

            -

      Optional

            -

            -

Edm.DateTime

False

The date and time the variable was created.

Description

            -

      Optional

      Optional

            -

Edm.String

True

The description of the variable.

IsEncrypted

            -

      Optional

      Optional

            -

Edm.Boolean

False

Indicates whether the variable is encrypted.

LastModifiedTime

            -

      Optional

            -

            -

Edm.DateTime

False

The date and time the variable was last modified.

Name

            -

      Optional

            -

            -

Edm.String

False

The name of the variable.

TenantID

            -

      Optional

            -

            -

Edm.Guid

False

Unique identifier of the tenant that manages the System Management Automation service.

Value

            -

      Optional

      Optional

            -

Edm.String

True

The value of the variable.

 

Note

*Direct access to the entity requires the key property VariableID. This property is not required to simply enumerate the Variables collection.

Relationships

This entity does not have any relationships.

Examples

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

See Also

Concepts

Variables