Job - List By Automation Account

Referenz

Service:: Automation

API Version:: 2023-11-01

Ruft eine Liste von Aufträgen ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
automationAccountName	path	True	string	Der Name des Automation-Kontos.
resourceGroupName	path	True	string	Name einer Azure-Ressourcengruppe. Regex pattern: `^[-\w\._]+$`
subscriptionId	path	True	string	Ruft die Abonnementanmeldeinformationen ab, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string	Client-API-Version.
$filter	query		string	Der Filter, der auf den Vorgang angewendet werden soll.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
clientRequestId		string	Identifiziert diese spezifische Clientanforderung.

Antworten

Name	Typ	Beschreibung
200 OK	JobListResultV2	OK
Other Status Codes	ErrorResponse	Automatisierungsfehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

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
}

Definitionen

Name	Beschreibung
ErrorResponse	Fehlerantwort eines Vorgangsfehlers
JobCollectionItem	Eigenschaften des Auftragsauflistungselements.
JobListResultV2	Das Antwortmodell für den Listenauftragsvorgang.
JobStatus	Ruft den status des Auftrags ab oder legt diese fest.
RunbookAssociationProperty	Die runbook-Eigenschaft, die der Entität zugeordnet ist.

ErrorResponse

Fehlerantwort eines Vorgangsfehlers

Name	Typ	Beschreibung
code	string	Fehlercode
message	string	Eine Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

JobCollectionItem

Eigenschaften des Auftragsauflistungselements.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource
name	string	Der Name der Ressource
properties.creationTime	string	Die Uhrzeit der Erstellung des Auftrags.
properties.endTime	string	Die Uhrzeit des Endes des Auftrags.
properties.jobId	string	Die ID des Auftrags.
properties.lastModifiedTime	string	Die Uhrzeit der letzten Änderung des Auftrags.
properties.provisioningState	string	Der Bereitstellungsstatus einer Ressource.
properties.runOn	string	Gibt den Namen der runOn-Gruppe an, in der der Auftrag ausgeführt wurde.
properties.runbook	RunbookAssociationProperty	Die Runbookzuordnung.
properties.startTime	string	Die Startzeit des Auftrags.
properties.status	JobStatus	Der Status des Auftrags.
type	string	Der Typ der Ressource.

JobListResultV2

Das Antwortmodell für den Listenauftragsvorgang.

Name	Typ	Beschreibung
nextLink	string	Der Link zur nächsten Seite.
value	JobCollectionItem[]	Liste der Aufträge.

JobStatus

Ruft den status des Auftrags ab oder legt diese fest.

Name	Typ	Beschreibung
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

Die runbook-Eigenschaft, die der Entität zugeordnet ist.

Name	Typ	Beschreibung
name	string	Ruft den Namen des Runbooks ab oder legt den Namen fest.