Activity - List By Module

Servizio:: Automation

Versione API:: 2023-11-01

Recuperare un elenco di attività nel modulo identificato dal nome del modulo.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
automationAccountName	path	True	string	Nome dell'account di automazione.
moduleName	path	True	string	Nome del modulo.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Nome di un gruppo di risorse di Azure.
subscriptionId	path	True	string	Ottiene le credenziali di sottoscrizione che identificano in modo univoco la sottoscrizione di Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata al servizio.
api-version	query	True	string	Versione dell'API client.

Risposte

Nome	Tipo	Descrizione
200 OK	ActivityListResult	OK
Other Status Codes	ErrorResponse	Risposta di errore di automazione che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

List activities by a module

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:: 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"
      }
    }
  ]
}

Definizioni

Nome	Descrizione
Activity	Definizione dell'attività.
ActivityListResult	Modello di risposta per l'operazione dell'attività di elenco.
ActivityOutputType	Definizione del tipo di output dell'attività.
ActivityParameter	Definizione del parametro dell'attività.
ActivityParameterSet	Definizione del set di parametri dell'attività.
ActivityParameterValidationSet	Definizione del set di convalida dei parametri dell'attività.
ErrorResponse	Risposta di errore di un errore dell'operazione

Activity

Object

Definizione dell'attività.

Nome	Tipo	Descrizione
id	string	Ottiene o imposta l'ID della risorsa.
name	string	Ottiene il nome dell'attività.
properties.creationTime	string (date-time)	Ottiene o imposta l'ora di creazione.
properties.definition	string	Ottiene o imposta il nome utente dell'attività.
properties.description	string	Ottiene o imposta la descrizione.
properties.lastModifiedTime	string (date-time)	Ottiene o imposta l'ora dell'ultima modifica.
properties.outputTypes	ActivityOutputType[]	Ottiene o imposta i tipi di output dell'attività.
properties.parameterSets	ActivityParameterSet[]	Ottiene o imposta i set di parametri dell'attività.

ActivityListResult

Object

Modello di risposta per l'operazione dell'attività di elenco.

Nome	Tipo	Descrizione
nextLink	string	Ottiene o imposta il collegamento successivo.
value	Activity[]	Ottiene o imposta un elenco di attività.

ActivityOutputType

Object

Definizione del tipo di output dell'attività.

Nome	Tipo	Descrizione
name	string	Ottiene o imposta il nome del tipo di output dell'attività.
type	string	Ottiene o imposta il tipo di output dell'attività.

ActivityParameter

Object

Definizione del parametro dell'attività.

Nome	Tipo	Descrizione
description	string	Ottiene o imposta la descrizione del parametro dell'attività.
isDynamic	boolean	Ottiene o imposta un valore booleano che indica true se il parametro è dinamico.
isMandatory	boolean	Ottiene o imposta un valore booleano che indica true se il parametro è obbligatorio. Se il valore è false, il parametro è facoltativo.
name	string	Ottiene o imposta il nome del parametro dell'attività.
position	integer (int64)	Ottiene o imposta la posizione del parametro dell'attività.
type	string	Ottiene o imposta il tipo del parametro dell'attività.
validationSet	ActivityParameterValidationSet[]	Ottiene o imposta il set di convalida del parametro dell'attività.
valueFromPipeline	boolean	Ottiene o imposta un valore booleano che indica true se il parametro può accettare valori dagli oggetti della pipeline in ingresso. Questa impostazione viene utilizzata se il cmdlet deve accedere all'oggetto di input completo. false indica che il parametro non può accettare valori dall'oggetto di input completo.
valueFromPipelineByPropertyName	boolean	Ottiene o imposta un valore booleano che indica true se il parametro può essere compilato da una proprietà dell'oggetto pipeline in ingresso con lo stesso nome di questo parametro. false indica che il parametro non può essere riempito dalla proprietà dell'oggetto pipeline in ingresso con lo stesso nome.
valueFromRemainingArguments	boolean	Ottiene o imposta un valore booleano che indica true se il parametro del cmdlet accetta tutti gli argomenti della riga di comando rimanenti associati a questo parametro sotto forma di matrice. false se il parametro del cmdlet non accetta tutti i valori degli argomenti rimanenti.

ActivityParameterSet

Object

Definizione del set di parametri dell'attività.

Nome	Tipo	Descrizione
name	string	Ottiene o imposta il nome del set di parametri dell'attività.
parameters	ActivityParameter[]	Ottiene o imposta i parametri del set di parametri dell'attività.

ActivityParameterValidationSet

Object

Definizione del set di convalida dei parametri dell'attività.

Nome	Tipo	Descrizione
memberValue	string	Ottiene o imposta il nome del membro del set di convalida dei parametri dell'attività.

ErrorResponse

Object

Risposta di errore di un errore dell'operazione

Nome	Tipo	Descrizione
code	string	Codice di errore
message	string	Messaggio di errore che indica il motivo per cui l'operazione non è riuscita.

Condividi tramite

Activity - List By Module

Parametri dell'URI

Risposte

Sicurezza

azure_auth

Ambiti

Esempio

List activities by a module

Esempio di richiesta

Risposta di esempio

Definizioni

Activity

ActivityListResult

ActivityOutputType

ActivityParameter

ActivityParameterSet

ActivityParameterValidationSet

ErrorResponse