Activity - Get

Service:

Automation

API Version:

2023-11-01

Retrieve the activity in the module identified by module name and activity name.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/modules/{moduleName}/activities/{activityName}?api-version=2023-11-01

URI Parameters

Name	In	Required	Type	Description
activityName	path	True	string	The name of activity.
automationAccountName	path	True	string	The name of the automation account.
moduleName	path	True	string	The name of module.
resourceGroupName	path	True	string	Name of an Azure Resource group. Regex pattern: ^[-\w\._]+$
subscriptionId	path	True	string	Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Client Api Version.

Responses

Name	Type	Description
200 OK	Activity	OK
Other Status Codes	ErrorResponse	Automation error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Get Activity in a module

Sample Request

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/modules/OmsCompositeResources/activities/Add-AzureRmAccount?api-version=2023-11-01

Sample Response

Status code:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/modules/AzureRM.Profile/activities/Add-AzureRmAccount",
  "name": "Add-AzureRmAccount",
  "properties": {
    "definition": "",
    "description": "The Add-AzureRmAcccount cmdlet adds an authenticated Azure account to use for Azure Resource Manager cmdlet requests.\n\nYou can use this authenticated account only with Azure Resource Manager cmdlets. To add an authenticated account for use with Service Management cmdlets, use the Add-AzureAccount or the Import-AzurePublishSettingsFile cmdlet.",
    "parameterSets": [
      {
        "name": "SubscriptionId",
        "parameters": [
          {
            "name": "AccessToken",
            "type": "System.String",
            "isMandatory": false,
            "isDynamic": false,
            "position": -2147483648,
            "valueFromPipeline": false,
            "valueFromPipelineByPropertyName": false,
            "valueFromRemainingArguments": false,
            "description": "Specify the feature description",
            "validationSet": []
          },
          {
            "name": "AccountId",
            "type": "System.String",
            "isMandatory": false,
            "isDynamic": false,
            "position": -2147483648,
            "valueFromPipeline": false,
            "valueFromPipelineByPropertyName": false,
            "valueFromRemainingArguments": false,
            "description": "Specify the feature description",
            "validationSet": []
          },
          {
            "name": "ApplicationId",
            "type": "System.String",
            "isMandatory": false,
            "isDynamic": false,
            "position": -2147483648,
            "valueFromPipeline": false,
            "valueFromPipelineByPropertyName": false,
            "valueFromRemainingArguments": false,
            "description": "Specify the feature description",
            "validationSet": []
          },
          {
            "name": "CertificateThumbprint",
            "type": "System.String",
            "isMandatory": false,
            "isDynamic": false,
            "position": -2147483648,
            "valueFromPipeline": false,
            "valueFromPipelineByPropertyName": false,
            "valueFromRemainingArguments": false,
            "description": "Specify the feature description",
            "validationSet": []
          },
          {
            "name": "Credential",
            "type": "System.Management.Automation.PSCredential",
            "isMandatory": false,
            "isDynamic": false,
            "position": -2147483648,
            "valueFromPipeline": false,
            "valueFromPipelineByPropertyName": false,
            "valueFromRemainingArguments": false,
            "description": "Specify the feature description",
            "validationSet": []
          },
          {
            "name": "Environment",
            "type": "Microsoft.Azure.Common.Authentication.Models.AzureEnvironment",
            "isMandatory": false,
            "isDynamic": false,
            "position": -2147483648,
            "valueFromPipeline": false,
            "valueFromPipelineByPropertyName": false,
            "valueFromRemainingArguments": false,
            "description": "Specify the feature description",
            "validationSet": []
          },
          {
            "name": "EnvironmentName",
            "type": "System.String",
            "isMandatory": false,
            "isDynamic": false,
            "position": -2147483648,
            "valueFromPipeline": false,
            "valueFromPipelineByPropertyName": false,
            "valueFromRemainingArguments": false,
            "description": "Specify the feature description",
            "validationSet": []
          },
          {
            "name": "SubscriptionId",
            "type": "System.String",
            "isMandatory": false,
            "isDynamic": false,
            "position": -2147483648,
            "valueFromPipeline": false,
            "valueFromPipelineByPropertyName": true,
            "valueFromRemainingArguments": false,
            "description": "Specify the feature description",
            "validationSet": []
          },
          {
            "name": "TenantId",
            "type": "System.String",
            "isMandatory": false,
            "isDynamic": false,
            "position": -2147483648,
            "valueFromPipeline": false,
            "valueFromPipelineByPropertyName": false,
            "valueFromRemainingArguments": false,
            "description": "Specify the feature description",
            "validationSet": []
          }
        ]
      },
      {
        "name": "ServicePrincipal",
        "parameters": [
          {
            "name": "Credential",
            "type": "System.Management.Automation.PSCredential",
            "isMandatory": true,
            "isDynamic": false,
            "position": -2147483648,
            "valueFromPipeline": false,
            "valueFromPipelineByPropertyName": false,
            "valueFromRemainingArguments": false,
            "description": "Specify the feature description",
            "validationSet": []
          },
          {
            "name": "Environment",
            "type": "Microsoft.Azure.Common.Authentication.Models.AzureEnvironment",
            "isMandatory": false,
            "isDynamic": false,
            "position": -2147483648,
            "valueFromPipeline": false,
            "valueFromPipelineByPropertyName": false,
            "valueFromRemainingArguments": false,
            "description": "Specify the feature description",
            "validationSet": []
          },
          {
            "name": "EnvironmentName",
            "type": "System.String",
            "isMandatory": false,
            "isDynamic": false,
            "position": -2147483648,
            "valueFromPipeline": false,
            "valueFromPipelineByPropertyName": false,
            "valueFromRemainingArguments": false,
            "description": "Specify the feature description",
            "validationSet": []
          },
          {
            "name": "ServicePrincipal",
            "type": "System.Management.Automation.SwitchParameter",
            "isMandatory": true,
            "isDynamic": false,
            "position": -2147483648,
            "valueFromPipeline": false,
            "valueFromPipelineByPropertyName": false,
            "valueFromRemainingArguments": false,
            "description": "Specify the feature description",
            "validationSet": []
          },
          {
            "name": "SubscriptionId",
            "type": "System.String",
            "isMandatory": false,
            "isDynamic": false,
            "position": -2147483648,
            "valueFromPipeline": false,
            "valueFromPipelineByPropertyName": true,
            "valueFromRemainingArguments": false,
            "description": "Specify the feature description",
            "validationSet": []
          },
          {
            "name": "SubscriptionName",
            "type": "System.String",
            "isMandatory": false,
            "isDynamic": false,
            "position": -2147483648,
            "valueFromPipeline": false,
            "valueFromPipelineByPropertyName": true,
            "valueFromRemainingArguments": false,
            "description": "Specify the feature description",
            "validationSet": []
          },
          {
            "name": "TenantId",
            "type": "System.String",
            "isMandatory": true,
            "isDynamic": false,
            "position": -2147483648,
            "valueFromPipeline": false,
            "valueFromPipelineByPropertyName": false,
            "valueFromRemainingArguments": false,
            "description": "Specify the feature description",
            "validationSet": []
          }
        ]
      },
      {
        "name": "SubscriptionName",
        "parameters": [
          {
            "name": "AccessToken",
            "type": "System.String",
            "isMandatory": false,
            "isDynamic": false,
            "position": -2147483648,
            "valueFromPipeline": false,
            "valueFromPipelineByPropertyName": false,
            "valueFromRemainingArguments": false,
            "description": "Specify the feature description",
            "validationSet": []
          },
          {
            "name": "AccountId",
            "type": "System.String",
            "isMandatory": false,
            "isDynamic": false,
            "position": -2147483648,
            "valueFromPipeline": false,
            "valueFromPipelineByPropertyName": false,
            "valueFromRemainingArguments": false,
            "description": "Specify the feature description",
            "validationSet": []
          },
          {
            "name": "ApplicationId",
            "type": "System.String",
            "isMandatory": false,
            "isDynamic": false,
            "position": -2147483648,
            "valueFromPipeline": false,
            "valueFromPipelineByPropertyName": false,
            "valueFromRemainingArguments": false,
            "description": "Specify the feature description",
            "validationSet": []
          },
          {
            "name": "CertificateThumbprint",
            "type": "System.String",
            "isMandatory": false,
            "isDynamic": false,
            "position": -2147483648,
            "valueFromPipeline": false,
            "valueFromPipelineByPropertyName": false,
            "valueFromRemainingArguments": false,
            "description": "Specify the feature description",
            "validationSet": []
          },
          {
            "name": "Credential",
            "type": "System.Management.Automation.PSCredential",
            "isMandatory": false,
            "isDynamic": false,
            "position": -2147483648,
            "valueFromPipeline": false,
            "valueFromPipelineByPropertyName": false,
            "valueFromRemainingArguments": false,
            "description": "Specify the feature description",
            "validationSet": []
          },
          {
            "name": "Environment",
            "type": "Microsoft.Azure.Common.Authentication.Models.AzureEnvironment",
            "isMandatory": false,
            "isDynamic": false,
            "position": -2147483648,
            "valueFromPipeline": false,
            "valueFromPipelineByPropertyName": false,
            "valueFromRemainingArguments": false,
            "description": "Specify the feature description",
            "validationSet": []
          },
          {
            "name": "EnvironmentName",
            "type": "System.String",
            "isMandatory": false,
            "isDynamic": false,
            "position": -2147483648,
            "valueFromPipeline": false,
            "valueFromPipelineByPropertyName": false,
            "valueFromRemainingArguments": false,
            "description": "Specify the feature description",
            "validationSet": []
          },
          {
            "name": "SubscriptionName",
            "type": "System.String",
            "isMandatory": false,
            "isDynamic": false,
            "position": -2147483648,
            "valueFromPipeline": false,
            "valueFromPipelineByPropertyName": true,
            "valueFromRemainingArguments": false,
            "description": "Specify the feature description",
            "validationSet": []
          },
          {
            "name": "TenantId",
            "type": "System.String",
            "isMandatory": false,
            "isDynamic": false,
            "position": -2147483648,
            "valueFromPipeline": false,
            "valueFromPipelineByPropertyName": false,
            "valueFromRemainingArguments": false,
            "description": "Specify the feature description",
            "validationSet": []
          }
        ]
      },
      {
        "name": "User",
        "parameters": [
          {
            "name": "Credential",
            "type": "System.Management.Automation.PSCredential",
            "isMandatory": false,
            "isDynamic": false,
            "position": -2147483648,
            "valueFromPipeline": false,
            "valueFromPipelineByPropertyName": false,
            "valueFromRemainingArguments": false,
            "description": "Specify the feature description",
            "validationSet": []
          },
          {
            "name": "Environment",
            "type": "Microsoft.Azure.Common.Authentication.Models.AzureEnvironment",
            "isMandatory": false,
            "isDynamic": false,
            "position": -2147483648,
            "valueFromPipeline": false,
            "valueFromPipelineByPropertyName": false,
            "valueFromRemainingArguments": false,
            "description": "Specify the feature description",
            "validationSet": []
          },
          {
            "name": "EnvironmentName",
            "type": "System.String",
            "isMandatory": false,
            "isDynamic": false,
            "position": -2147483648,
            "valueFromPipeline": false,
            "valueFromPipelineByPropertyName": false,
            "valueFromRemainingArguments": false,
            "description": "Specify the feature description",
            "validationSet": []
          },
          {
            "name": "TenantId",
            "type": "System.String",
            "isMandatory": false,
            "isDynamic": false,
            "position": -2147483648,
            "valueFromPipeline": false,
            "valueFromPipelineByPropertyName": false,
            "valueFromRemainingArguments": false,
            "description": "Specify the feature description",
            "validationSet": []
          }
        ]
      },
      {
        "name": "AccessToken",
        "parameters": [
          {
            "name": "AccessToken",
            "type": "System.String",
            "isMandatory": true,
            "isDynamic": false,
            "position": -2147483648,
            "valueFromPipeline": false,
            "valueFromPipelineByPropertyName": false,
            "valueFromRemainingArguments": false,
            "description": "Specify the feature description",
            "validationSet": []
          },
          {
            "name": "AccountId",
            "type": "System.String",
            "isMandatory": true,
            "isDynamic": false,
            "position": -2147483648,
            "valueFromPipeline": false,
            "valueFromPipelineByPropertyName": false,
            "valueFromRemainingArguments": false,
            "description": "Specify the feature description",
            "validationSet": []
          },
          {
            "name": "Environment",
            "type": "Microsoft.Azure.Common.Authentication.Models.AzureEnvironment",
            "isMandatory": false,
            "isDynamic": false,
            "position": -2147483648,
            "valueFromPipeline": false,
            "valueFromPipelineByPropertyName": false,
            "valueFromRemainingArguments": false,
            "description": "Specify the feature description",
            "validationSet": []
          },
          {
            "name": "EnvironmentName",
            "type": "System.String",
            "isMandatory": false,
            "isDynamic": false,
            "position": -2147483648,
            "valueFromPipeline": false,
            "valueFromPipelineByPropertyName": false,
            "valueFromRemainingArguments": false,
            "description": "Specify the feature description",
            "validationSet": []
          },
          {
            "name": "TenantId",
            "type": "System.String",
            "isMandatory": false,
            "isDynamic": false,
            "position": -2147483648,
            "valueFromPipeline": false,
            "valueFromPipelineByPropertyName": false,
            "valueFromRemainingArguments": false,
            "description": "Specify the feature description",
            "validationSet": []
          }
        ]
      },
      {
        "name": "ServicePrincipalCertificate",
        "parameters": [
          {
            "name": "ApplicationId",
            "type": "System.String",
            "isMandatory": true,
            "isDynamic": false,
            "position": -2147483648,
            "valueFromPipeline": false,
            "valueFromPipelineByPropertyName": false,
            "valueFromRemainingArguments": false,
            "description": "Specify the feature description",
            "validationSet": []
          },
          {
            "name": "CertificateThumbprint",
            "type": "System.String",
            "isMandatory": true,
            "isDynamic": false,
            "position": -2147483648,
            "valueFromPipeline": false,
            "valueFromPipelineByPropertyName": false,
            "valueFromRemainingArguments": false,
            "description": "Specify the feature description",
            "validationSet": []
          },
          {
            "name": "Environment",
            "type": "Microsoft.Azure.Common.Authentication.Models.AzureEnvironment",
            "isMandatory": false,
            "isDynamic": false,
            "position": -2147483648,
            "valueFromPipeline": false,
            "valueFromPipelineByPropertyName": false,
            "valueFromRemainingArguments": false,
            "description": "Specify the feature description",
            "validationSet": []
          },
          {
            "name": "EnvironmentName",
            "type": "System.String",
            "isMandatory": false,
            "isDynamic": false,
            "position": -2147483648,
            "valueFromPipeline": false,
            "valueFromPipelineByPropertyName": false,
            "valueFromRemainingArguments": false,
            "description": "Specify the feature description",
            "validationSet": []
          },
          {
            "name": "ServicePrincipal",
            "type": "System.Management.Automation.SwitchParameter",
            "isMandatory": true,
            "isDynamic": false,
            "position": -2147483648,
            "valueFromPipeline": false,
            "valueFromPipelineByPropertyName": false,
            "valueFromRemainingArguments": false,
            "description": "Specify the feature description",
            "validationSet": []
          },
          {
            "name": "TenantId",
            "type": "System.String",
            "isMandatory": true,
            "isDynamic": false,
            "position": -2147483648,
            "valueFromPipeline": false,
            "valueFromPipelineByPropertyName": false,
            "valueFromRemainingArguments": false,
            "description": "Specify the feature description",
            "validationSet": []
          }
        ]
      }
    ],
    "outputTypes": [
      {
        "name": "Microsoft.Azure.Commands.Profile.Models.PSAzureProfile",
        "type": "Microsoft.Azure.Commands.Profile.Models.PSAzureProfile"
      }
    ],
    "creationTime": "2017-03-17T17:05:21.697+00:00",
    "lastModifiedTime": "2017-03-17T17:05:21.697+00:00"
  }
}

Definitions

Name	Description
Activity	Definition of the activity.
ActivityOutputType	Definition of the activity output type.
ActivityParameter	Definition of the activity parameter.
ActivityParameterSet	Definition of the activity parameter set.
ActivityParameterValidationSet	Definition of the activity parameter validation set.
ErrorResponse	Error response of an operation failure

Activity

Definition of the activity.

Name	Type	Description
id	string	Gets or sets the id of the resource.
name	string	Gets the name of the activity.
properties.creationTime	string	Gets or sets the creation time.
properties.definition	string	Gets or sets the user name of the activity.
properties.description	string	Gets or sets the description.
properties.lastModifiedTime	string	Gets or sets the last modified time.
properties.outputTypes	ActivityOutputType[]	Gets or sets the output types of the activity.
properties.parameterSets	ActivityParameterSet[]	Gets or sets the parameter sets of the activity.

ActivityOutputType

Definition of the activity output type.

Name	Type	Description
name	string	Gets or sets the name of the activity output type.
type	string	Gets or sets the type of the activity output type.

ActivityParameter

Definition of the activity parameter.

Name	Type	Description
description	string	Gets or sets the description of the activity parameter.
isDynamic	boolean	Gets or sets a Boolean value that indicates true if the parameter is dynamic.
isMandatory	boolean	Gets or sets a Boolean value that indicates true if the parameter is required. If the value is false, the parameter is optional.
name	string	Gets or sets the name of the activity parameter.
position	integer	Gets or sets the position of the activity parameter.
type	string	Gets or sets the type of the activity parameter.
validationSet	ActivityParameterValidationSet[]	Gets or sets the validation set of activity parameter.
valueFromPipeline	boolean	Gets or sets a Boolean value that indicates true if the parameter can take values from the incoming pipeline objects. This setting is used if the cmdlet must access the complete input object. false indicates that the parameter cannot take values from the complete input object.
valueFromPipelineByPropertyName	boolean	Gets or sets a Boolean value that indicates true if the parameter can be filled from a property of the incoming pipeline object that has the same name as this parameter. false indicates that the parameter cannot be filled from the incoming pipeline object property with the same name.
valueFromRemainingArguments	boolean	Gets or sets a Boolean value that indicates true if the cmdlet parameter accepts all the remaining command-line arguments that are associated with this parameter in the form of an array. false if the cmdlet parameter does not accept all the remaining argument values.

ActivityParameterSet

Definition of the activity parameter set.

Name	Type	Description
name	string	Gets or sets the name of the activity parameter set.
parameters	ActivityParameter[]	Gets or sets the parameters of the activity parameter set.

ActivityParameterValidationSet

Definition of the activity parameter validation set.

Name	Type	Description
memberValue	string	Gets or sets the name of the activity parameter validation set member.

ErrorResponse

Error response of an operation failure

Name	Type	Description
code	string	Error code
message	string	Error message indicating why the operation failed.