Get information about a module's activity

Article
09/16/2015

The Get module information about a module's activity operation returns information about an activity in a module.

Request

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, <module-name> with the name of the module, and <activity-name> with the name of the activity 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>/modules/<module-name>/activities/<activity-name>?api-version=2014-12-08

URI Parameters

Parameter	Description
api-version	Required. Must be set to 2014-12-08.

Request Headers

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.

Request Body

None

Response

Status Code

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

Response Headers

Request Header	Description
x-ms-request-id	A unique identifier for the current operation.

Response Body

{
   "name":"Get-AzureEnvironment",
   "properties":{
      "definition":"",
      "description":"Gets Azure environments ^http:\/\/go.microsoft.com\/fwlink\/?LinkID=397621^",
      "parameterSets":[
         {
            "name":"__AllParameterSets",
            "parameters":[
               {
                  "name":"Name",
                  "type":"System.String",
                  "isMandatory":false,
                  "isDynamic":false,
                  "position":0,
                  "valueFromPipeline":false,
                  "valueFromPipelineByPropertyName":true,
                  "valueFromRemainingArguments":false
               },
               {
                  "name":"Profile",
                  "type":"Microsoft.Azure.Common.Authentication.Models.AzureProfile",
                  "isMandatory":false,
                  "isDynamic":false,
                  "position":-2147483648,
                  "valueFromPipeline":false,
                  "valueFromPipelineByPropertyName":false,
                  "valueFromRemainingArguments":false
               }
            ]
         }
      ],
      "outputTypes":[
         {
            "name":"System.Collections.Generic.List`1[[Microsoft.Azure.Common.Authentication.Models.AzureEnvironment, Microsoft.Azure.Common.Authentication, Version=1.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]",
            "type":"System.Collections.Generic.List`1[Microsoft.Azure.Common.Authentication.Models.AzureEnvironment]"
         }
      ],
      "creationTime":"2015-04-30T11:40:09.79+00:00",
      "lastModifiedTime":"2015-04-30T11:40:09.79+00:00"
   }
}

Element	Description
name	The name of the activity.
properties/definition	The definition of the activity.
properties/description	The description of the activity.
properties/parameterSets/name	The name of a parameter set.
properties/parameterSets/parameters/name	The name of a parameter
properties/parameterSets/parameters/type	The type of the parameter
properties/parameterSets/parameters/isMandatory	Whether the parameter is mandatory.
properties/parameterSets/parameters/isDynamic	Whether the parameter is dynamic.
properties/parameterSets/parameters/position	The position of the parameter.
properties/parameterSets/parameters/valueFromPipeline	The value of the parameter in the pipeline.
properties/parameterSets/parameters/valueFromPipelineByPropertyName	The value of the parameter in the pipeline by its property name.
properties/parameterSets/parameters/valueFromRemainingArguments	The value of the parameter from the remaining arguments.
properties/outputTypes/name	The name of an output type
properties/outputTypes/value	The value of an output type
properties/creationTime	The date and time the activity was created.
properties/lastModifiedTime	The date and time the activity was last changed.

Share via