Job - List By Automation Account

Dienst:: Automation

API-Version:: 2024-10-23

Dient zum Abrufen einer Liste von Aufträgen.

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
automationAccountName	path	True	string	Der Name des Automatisierungskontos.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.
$filter	query		string	Der auf den Vorgang anzuwendende Filter.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
clientRequestId		string	Identifiziert diese spezifische Clientanforderung.

Antworten

Name	Typ	Beschreibung
200 OK	JobListResultV2	Der Azure-Vorgang wurde erfolgreich abgeschlossen.
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

List jobs by automation account

Beispielanforderung

GET https://management.azure.com/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/ContosoAutomationAccount/jobs?api-version=2024-10-23

from azure.identity import DefaultAzureCredential

from azure.mgmt.automation import AutomationClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-automation
# USAGE
    python list_jobs_by_automation_account.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = AutomationClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.job.list_by_automation_account(
        resource_group_name="mygroup",
        automation_account_name="ContosoAutomationAccount",
    )
    for item in response:
        print(item)


# x-ms-original-file: 2024-10-23/job/listJobsByAutomationAccount.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armautomation_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

// Generated from example definition: 2024-10-23/job/listJobsByAutomationAccount.json
func ExampleJobClient_NewListByAutomationAccountPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armautomation.NewClientFactory("51766542-3ed7-4a72-a187-0c8ab644ddab", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewJobClient().NewListByAutomationAccountPager("mygroup", "ContosoAutomationAccount", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page = armautomation.JobClientListByAutomationAccountResponse{
		// 	JobListResultV2: armautomation.JobListResultV2{
		// 		Value: []*armautomation.JobCollectionItem{
		// 			{
		// 				Name: to.Ptr("job1"),
		// 				Type: to.Ptr("Microsoft.Automation/AutomationAccounts/Jobs"),
		// 				ID: to.Ptr("/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/ContosoAutomationAccount/jobs/job1"),
		// 				Properties: &armautomation.JobCollectionItemProperties{
		// 					CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-03-30T05:53:30.243+00:00"); return t}()),
		// 					EndTime: nil,
		// 					JobID: to.Ptr("45203a94-a8cb-47c3-8ce4-4dcc3a5f7d23"),
		// 					JobRuntimeEnvironment: &armautomation.JobRuntimeEnvironment{
		// 						RuntimeEnvironmentName: to.Ptr("environmentName"),
		// 					},
		// 					LastModifiedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-03-30T05:53:30.243+00:00"); return t}()),
		// 					ProvisioningState: to.Ptr("Succeeded"),
		// 					Runbook: &armautomation.RunbookAssociationProperty{
		// 						Name: to.Ptr("TestRunbook"),
		// 					},
		// 					StartTime: nil,
		// 					Status: to.Ptr(armautomation.JobStatusNew),
		// 				},
		// 			},
		// 			{
		// 				Name: to.Ptr("job2"),
		// 				Type: to.Ptr("Microsoft.Automation/AutomationAccounts/Jobs"),
		// 				ID: to.Ptr("/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/ContosoAutomationAccount/jobs/job2"),
		// 				Properties: &armautomation.JobCollectionItemProperties{
		// 					CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-03-30T05:46:49.37+00:00"); return t}()),
		// 					EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-03-30T05:48:38.857+00:00"); return t}()),
		// 					JobID: to.Ptr("7584055f-5118-460a-a2dd-5176c9c8efe9"),
		// 					JobRuntimeEnvironment: &armautomation.JobRuntimeEnvironment{
		// 						RuntimeEnvironmentName: to.Ptr("environmentName"),
		// 					},
		// 					LastModifiedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-03-30T05:48:38.857+00:00"); return t}()),
		// 					ProvisioningState: to.Ptr("Succeeded"),
		// 					Runbook: &armautomation.RunbookAssociationProperty{
		// 						Name: to.Ptr("TestRunbook"),
		// 					},
		// 					StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-03-30T05:47:35.2+00:00"); return t}()),
		// 					Status: to.Ptr(armautomation.JobStatusCompleted),
		// 				},
		// 			},
		// 		},
		// 	},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { AutomationClient } = require("@azure/arm-automation");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to retrieve a list of jobs.
 *
 * @summary retrieve a list of jobs.
 * x-ms-original-file: 2024-10-23/job/listJobsByAutomationAccount.json
 */
async function listJobsByAutomationAccount() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "51766542-3ed7-4a72-a187-0c8ab644ddab";
  const client = new AutomationClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.jobOperations.listByAutomationAccount(
    "mygroup",
    "ContosoAutomationAccount",
  )) {
    resArray.push(item);
  }

  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Beispiel für eine Antwort

Statuscode:: 200

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

Definitionen

Name	Beschreibung
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
JobCollectionItem	Eigenschaften des Auftragssammlungselements.
JobListResultV2	Das Antwortmodell für den Listenauftragsvorgang.
JobRuntimeEnvironment	Die Runbook-Eigenschaft, die der Entität zugeordnet ist.
JobStatus	Dient zum Abrufen oder Festlegen des Status des Auftrags.
RunbookAssociationProperty	Die Runbook-Eigenschaft, die der Entität zugeordnet ist.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

JobCollectionItem

Objekt

Eigenschaften des Auftragssammlungselements.

Name	Typ	Beschreibung
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Der Name der Ressource
properties.creationTime	string (date-time)	Die Erstellungszeit des Auftrags.
properties.endTime	string (date-time)	Die Endzeit des Auftrags.
properties.jobId	string (uuid)	Die ID des Auftrags.
properties.jobRuntimeEnvironment	JobRuntimeEnvironment	Runtime Environment-Eigenschaft
properties.lastModifiedTime	string (date-time)	Der Zeitpunkt der letzten Änderung des Auftrags.
properties.provisioningState	string	Der Bereitstellungsstatus einer Ressource.
properties.runOn	string	Gibt den RunOn-Gruppennamen an, in dem der Auftrag ausgeführt wurde.
properties.runbook	RunbookAssociationProperty	Die Runbookzuordnung.
properties.startTime	string (date-time)	Die Startzeit des Auftrags.
properties.startedBy	string	Ruft den Auftrag ab, der gestartet wurde, oder legt den Auftrag fest.
properties.status	JobStatus	Der Status des Auftrags.
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

JobListResultV2

Objekt

Das Antwortmodell für den Listenauftragsvorgang.

Name	Typ	Beschreibung
nextLink	string (uri)	Der Link zur nächsten Seite der Elemente
value	JobCollectionItem[]	Die JobCollectionItem-Artikel auf dieser Seite

JobRuntimeEnvironment

Objekt

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

Name	Typ	Beschreibung
runtimeEnvironmentName	string	Name der Laufzeitumgebung.

JobStatus

Enumeration

Dient zum Abrufen oder Festlegen des Status des Auftrags.

Wert	Beschreibung
New	Neu
Activating	Aktivierend
Running	Laufen
Completed	Abgeschlossen
Failed	gescheitert
Stopped	Angehalten
Blocked	Blocked
Suspended	Suspendiert
Disconnected	Verbindung unterbrochen
Suspending	Anhalten
Stopping	Anhalten
Resuming	Wird fortgesetzt
Removing	Entfernen

RunbookAssociationProperty

Objekt

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

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

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.