Activity - List By Module

  • Reference
Service:
Automation
API Version:
2023-11-01

Retrieve a list of activities in the module identified by module name.

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

URI Parameters

Name In Required Type Description
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

ActivityListResult

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

List activities by a module

Sample Request

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

Sample Response

Status code:
200 
{
  "value": [
    {
      "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": null,
        "outputTypes": null,
        "creationTime": "2017-03-17T17:05:21.697+00:00",
        "lastModifiedTime": "2017-03-17T17:05:21.697+00:00"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/modules/AzureRM.Profile/activities/Add-AzureRmEnvironment",
      "name": "Add-AzureRmEnvironment",
      "properties": {
        "definition": "",
        "description": "The Add-AzureRmEnvironment cmdlet adds endpoints and metadata to enable Azure Resource Manager cmdlets to connect with a new instance of Azure Resource Manager. The built-in environments AzureCloud and AzureChinaCloud target existing public instances of Azure Resource Manager.",
        "parameterSets": null,
        "outputTypes": null,
        "creationTime": "2017-03-17T17:05:21.697+00:00",
        "lastModifiedTime": "2017-03-17T17:05:21.697+00:00"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/modules/AzureRM.Profile/activities/Disable-AzureRmDataCollection",
      "name": "Disable-AzureRmDataCollection",
      "properties": {
        "definition": "",
        "description": "",
        "parameterSets": null,
        "outputTypes": null,
        "creationTime": "2017-03-17T17:05:21.713+00:00",
        "lastModifiedTime": "2017-03-17T17:05:21.713+00:00"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/modules/AzureRM.Profile/activities/Enable-AzureRmDataCollection",
      "name": "Enable-AzureRmDataCollection",
      "properties": {
        "definition": "",
        "description": "",
        "parameterSets": null,
        "outputTypes": null,
        "creationTime": "2017-03-17T17:05:21.713+00:00",
        "lastModifiedTime": "2017-03-17T17:05:21.713+00:00"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/modules/AzureRM.Profile/activities/Get-AzureRmContext",
      "name": "Get-AzureRmContext",
      "properties": {
        "definition": "",
        "description": "The Get-AzureRmContext cmdlet gets the current metadata used to authenticate Azure Resource Manager requests.\n\nThis cmdlet gets the Active Directory account, Active Directory tenant, Azure subscription, and the targeted Azure environment. Azure Resource Manager cmdlets use these settings by default when making Azure Resource Manager requests.",
        "parameterSets": null,
        "outputTypes": null,
        "creationTime": "2017-03-17T17:05:21.713+00:00",
        "lastModifiedTime": "2017-03-17T17:05:21.713+00:00"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/modules/AzureRM.Profile/activities/Get-AzureRmEnvironment",
      "name": "Get-AzureRmEnvironment",
      "properties": {
        "definition": "",
        "description": "The Get-AzureRmEnvironment cmdlet gets endpoints and metadata for an instance of Azure services.",
        "parameterSets": null,
        "outputTypes": null,
        "creationTime": "2017-03-17T17:05:21.697+00:00",
        "lastModifiedTime": "2017-03-17T17:05:21.697+00:00"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/modules/AzureRM.Profile/activities/Get-AzureRmSubscription",
      "name": "Get-AzureRmSubscription",
      "properties": {
        "definition": "",
        "description": "The Get-AzureRmSubscription cmdlet gets the subscription ID, subscription name, and home tenant for subscriptions that the current account can access.",
        "parameterSets": null,
        "outputTypes": null,
        "creationTime": "2017-03-17T17:05:21.697+00:00",
        "lastModifiedTime": "2017-03-17T17:05:21.697+00:00"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/modules/AzureRM.Profile/activities/Get-AzureRmTenant",
      "name": "Get-AzureRmTenant",
      "properties": {
        "definition": "",
        "description": "The Get-AzureRmTenant cmdlet gets tenants authorized for the current user.",
        "parameterSets": null,
        "outputTypes": null,
        "creationTime": "2017-03-17T17:05:21.697+00:00",
        "lastModifiedTime": "2017-03-17T17:05:21.697+00:00"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/modules/AzureRM.Profile/activities/Remove-AzureRmEnvironment",
      "name": "Remove-AzureRmEnvironment",
      "properties": {
        "definition": "",
        "description": "The Remove-AzureRmEnvironment cmdlet removes endpoints and metadata information for connecting to a given Azure instance.",
        "parameterSets": null,
        "outputTypes": null,
        "creationTime": "2017-03-17T17:05:21.697+00:00",
        "lastModifiedTime": "2017-03-17T17:05:21.697+00:00"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/modules/AzureRM.Profile/activities/Save-AzureRmProfile",
      "name": "Save-AzureRmProfile",
      "properties": {
        "definition": "",
        "description": "The Save-AzureRmProfile cmdlet saves the current authentication information for use in other PowerShell sessions.",
        "parameterSets": null,
        "outputTypes": null,
        "creationTime": "2017-03-17T17:05:21.697+00:00",
        "lastModifiedTime": "2017-03-17T17:05:21.697+00:00"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/modules/AzureRM.Profile/activities/Select-AzureRmProfile",
      "name": "Select-AzureRmProfile",
      "properties": {
        "definition": "",
        "description": "The Select-AzureRmProfile cmdlet loads authentication information from a file to set the Azure environment and context. Cmdlets that you run in the current session use this information to authenticate requests to Azure Resource Manager.",
        "parameterSets": null,
        "outputTypes": null,
        "creationTime": "2017-03-17T17:05:21.697+00:00",
        "lastModifiedTime": "2017-03-17T17:05:21.697+00:00"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/modules/AzureRM.Profile/activities/Set-AzureRmContext",
      "name": "Set-AzureRmContext",
      "properties": {
        "definition": "",
        "description": "The Set-AzureRmContext cmdlet sets authentication information for cmdlets that you run in the current session. The context includes tenant, subscription, and environment information.",
        "parameterSets": null,
        "outputTypes": null,
        "creationTime": "2017-03-17T17:05:21.697+00:00",
        "lastModifiedTime": "2017-03-17T17:05:21.697+00:00"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/modules/AzureRM.Profile/activities/Set-AzureRmEnvironment",
      "name": "Set-AzureRmEnvironment",
      "properties": {
        "definition": "",
        "description": "The Set-AzureRMEnvironment cmdlet sets endpoints and metadata for connecting to an instance of Azure.",
        "parameterSets": null,
        "outputTypes": null,
        "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.
ActivityListResult

The response model for the list activity operation.
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.

ActivityListResult

The response model for the list activity operation.

Name Type Description
nextLink

string

Gets or sets the next link.
value

Activity[]

Gets or sets a list of activities.

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.