Job - List By Automation Account

Tjänst:

Automation

API-version:

2023-11-01

Hämta en lista över jobb.

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

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
automationAccountName	path	True	string	Namnet på automationskontot.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Namnet på en Azure-resursgrupp.
subscriptionId	path	True	string	Hämtar prenumerationsautentiseringsuppgifter som unikt identifierar Microsoft Azure-prenumeration. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.
api-version	query	True	string	Klient-API-version.
$filter	query		string	Filtret som ska tillämpas på åtgärden.

Begärandehuvud

Name	Obligatorisk	Typ	Description
clientRequestId		string	Identifierar den här specifika klientbegäran.

Svar

Name	Typ	Description
200 OK	JobListResultV2	OKEJ
Other Status Codes	ErrorResponse	Automation-felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

List jobs by automation account

Exempelbegäran

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

Exempelsvar

Statuskod:

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
}

Definitioner

Name	Description
ErrorResponse	Felsvar på ett åtgärdsfel
JobCollectionItem	Egenskaper för jobbsamlingsobjekt.
JobListResultV2	Svarsmodellen för listjobbsåtgärden.
JobStatus	Hämtar eller anger jobbets status.
RunbookAssociationProperty	Runbook-egenskapen som är associerad med entiteten.

ErrorResponse

Objekt

Felsvar på ett åtgärdsfel

Name	Typ	Description
code	string	Felkod
message	string	Felmeddelande som anger varför åtgärden misslyckades.

JobCollectionItem

Objekt

Egenskaper för jobbsamlingsobjekt.

Name	Typ	Description
id	string	Fullständigt kvalificerat resurs-ID för resursen
name	string	Namnet på resursen
properties.creationTime	string (date-time)	Tiden då jobbet skapades.
properties.endTime	string (date-time)	Jobbets sluttid.
properties.jobId	string (uuid)	Jobbets ID.
properties.lastModifiedTime	string (date-time)	Den senaste ändrade tiden för jobbet.
properties.provisioningState	string	Etableringstillståndet för en resurs.
properties.runOn	string	Anger det runOn-gruppnamn där jobbet kördes.
properties.runbook	RunbookAssociationProperty	Runbook-associationen.
properties.startTime	string (date-time)	Starttiden för jobbet.
properties.status	JobStatus	Jobbets status.
type	string	Resurstypen.

JobListResultV2

Objekt

Svarsmodellen för listjobbsåtgärden.

Name	Typ	Description
nextLink	string	Länken till nästa sida.
value	JobCollectionItem[]	Lista över jobb.

JobStatus

Uppräkning

Hämtar eller anger jobbets status.

Värde	Description
Activating
Blocked
Completed
Disconnected
Failed
New
Removing
Resuming
Running
Stopped
Stopping
Suspended
Suspending

RunbookAssociationProperty

Objekt

Runbook-egenskapen som är associerad med entiteten.

Name	Typ	Description
name	string	Hämtar eller anger namnet på runbooken.