Job - List By Automation Account

Riferimento

Service:: Automation

API Version:: 2023-11-01

Recuperare un elenco di processi.

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

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs?$filter={$filter}&api-version=2023-11-01

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
automationAccountName	path	True	string	Nome dell'account di automazione.
resourceGroupName	path	True	string	Nome di un gruppo di risorse di Azure. Regex pattern: `^[-\w\._]+$`
subscriptionId	path	True	string	Ottiene le credenziali di sottoscrizione che consentono di identificare in modo univoco la sottoscrizione Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata di servizio.
api-version	query	True	string	Versione dell'API client.
$filter	query		string	Filtro da applicare all'operazione.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
clientRequestId		string	Identifica questa richiesta client specifica.

Risposte

Nome	Tipo	Descrizione
200 OK	JobListResultV2	OK
Other Status Codes	ErrorResponse	Risposta di errore di automazione che descrive perché l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

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

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

List jobs by automation account

Sample Request

HTTP

GET https://management.azure.com/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/jobs?api-version=2023-11-01

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/jobs/job1",
      "name": "job1",
      "type": "Microsoft.Automation/AutomationAccounts/Jobs",
      "properties": {
        "jobId": "45203a94-a8cb-47c3-8ce4-4dcc3a5f7d23",
        "runbook": {
          "name": "TestRunbook"
        },
        "provisioningState": "Succeeded",
        "status": "New",
        "creationTime": "2017-03-30T05:53:30.243+00:00",
        "startTime": null,
        "lastModifiedTime": "2017-03-30T05:53:30.243+00:00",
        "endTime": null
      }
    },
    {
      "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/jobs/job2",
      "name": "job2",
      "type": "Microsoft.Automation/AutomationAccounts/Jobs",
      "properties": {
        "jobId": "7584055f-5118-460a-a2dd-5176c9c8efe9",
        "runbook": {
          "name": "TestRunbook"
        },
        "provisioningState": "Succeeded",
        "status": "Completed",
        "creationTime": "2017-03-30T05:46:49.37+00:00",
        "startTime": "2017-03-30T05:47:35.2+00:00",
        "lastModifiedTime": "2017-03-30T05:48:38.857+00:00",
        "endTime": "2017-03-30T05:48:38.857+00:00"
      }
    }
  ],
  "nextLink": null
}

Definizioni

Nome	Descrizione
ErrorResponse	Risposta di errore di un errore dell'operazione
JobCollectionItem	Proprietà dell'elemento della raccolta processi.
JobListResultV2	Modello di risposta per l'operazione di processo elenco.
JobStatus	Ottiene o imposta lo stato del processo.
RunbookAssociationProperty	Proprietà runbook associata all'entità.

ErrorResponse

Risposta di errore di un errore dell'operazione

Nome	Tipo	Descrizione
code	string	Codice di errore
message	string	Messaggio di errore che indica perché l'operazione non è riuscita.

JobCollectionItem

Proprietà dell'elemento della raccolta processi.

Nome	Tipo	Descrizione
id	string	ID risorsa completo per la risorsa
name	string	nome della risorsa.
properties.creationTime	string	Ora di creazione del processo.
properties.endTime	string	Ora di fine del processo.
properties.jobId	string	ID del processo.
properties.lastModifiedTime	string	Ora dell'ultima modifica del processo.
properties.provisioningState	string	Stato di provisioning di una risorsa.
properties.runOn	string	Specifica il nome del gruppo runOn in cui è stato eseguito il processo.
properties.runbook	RunbookAssociationProperty	Associazione runbook.
properties.startTime	string	Ora di inizio del processo.
properties.status	JobStatus	Stato del processo.
type	string	Tipo di risorsa.

JobListResultV2

Modello di risposta per l'operazione di processo elenco.

Nome	Tipo	Descrizione
nextLink	string	Collegamento alla pagina successiva.
value	JobCollectionItem[]	Elenco dei processi.

JobStatus

Ottiene o imposta lo stato del processo.

Nome	Tipo	Descrizione
Activating	string
Blocked	string
Completed	string
Disconnected	string
Failed	string
New	string
Removing	string
Resuming	string
Running	string
Stopped	string
Stopping	string
Suspended	string
Suspending	string

RunbookAssociationProperty

Proprietà runbook associata all'entità.

Nome	Tipo	Descrizione
name	string	Ottiene o imposta il nome del runbook.

Share via