Compartilhar via

ActivityParameter

  • Artigo

The ActivityParameter entity represents an activity parameter in a System Management Automation runbook. The ActivityParameters collection includes all of the activity parameters in all the runbooks in the local System Management Automation environment.

Inheritance Hierarchy

Orchestrator.ResourceModel
  ActivityParameter

Supported HTTP Verbs

Create (POST) Read (GET) Update (PUT) Delete (DELETE)

False

True

False

False

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/MERGE) Delete (DELETE) Type Nullable Description

ActivityParameterID

            -

      Optional*

            -

            -

Edm.Guid

False

Key Property

The unique identifier of the activity parameter.

ActivityParameterSetID

            -

      Optional

            -

            -

Edm.Guid

False

The unique identifier of the activity parameter set.

IsDynamic

            -

      Optional

            -

            -

Edm.Boolean

True

Identifies whether the parameter is dynamic.

IsMandatory

            -

      Optional

            -

            -

Edm.Boolean

True

Indicates whether the parameter is required.

Name

            -

      Optional

            -

            -

Edm.String

False

The name of the activity parameter.

Position

            -

      Optional

            -

            -

Edm.Int32

True

The position of the parameter in the command-line string.

TenantID

            -

      Optional

            -

            -

Edm.Guid

False

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

Type

            -

      Optional

            -

            -

Edm.String

False

The name of the activity parameter’s type.

ValueFromPipeline

            -

      Optional

            -

            -

Edm.Boolean

True

Indicates whether the parameter can take values from incoming pipeline objects.

ValueFromPipelineByPropertyName

            -

      Optional

            -

            -

Edm.Boolean

True

Indicates whether the parameter can take values from a property of the incoming pipeline object that has the same name as this parameter.

ValueFromRemainingArguments

            -

      Optional

            -

            -

Edm.Boolean

True

Indicates whether the parameter accepts all the remaining command-line arguments that are associated with this parameter.

 

Note

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

ActivityParameterSet

One

ActivityParameterSetID

ActivityParameterSet

ActivityParameterSetID

Examples

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

See Also

Concepts

ActivityParameters