Job - List By Automation Account

Servizio:: Automation

Versione API:: 2024-10-23

Recuperare un elenco di processi.

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

Con parametri facoltativi:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
automationAccountName	path	True	string	Nome dell'account di automazione.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
subscriptionId	path	True	string (uuid)	ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.
$filter	query		string	Il 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	L'operazione di Azure è stata completata correttamente.
Other Status Codes	ErrorResponse	Risposta di errore imprevista.

Sicurezza

azure_auth

Azure Active Directory OAuth2 Flow.

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 jobs by automation account

Esempio di richiesta

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

Risposta di esempio

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

Definizioni

Nome	Descrizione
createdByType	Tipo di identità che ha creato la risorsa.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
JobCollectionItem	Proprietà degli elementi della raccolta processi.
JobListResultV2	Modello di risposta per l'operazione di elenco del processo.
JobRuntimeEnvironment	Proprietà del runbook associata all'entità.
JobStatus	Ottiene o imposta lo stato del processo.
RunbookAssociationProperty	Proprietà del runbook associata all'entità.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore	Descrizione
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Oggetto

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Oggetto

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Oggetto

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

JobCollectionItem

Oggetto

Proprietà degli elementi della raccolta processi.

Nome	Tipo	Descrizione
id	string (arm-id)	ID risorsa completo per la risorsa. Ad esempio, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nome della risorsa
properties.creationTime	string (date-time)	Ora di creazione del processo.
properties.endTime	string (date-time)	Ora di fine del processo.
properties.jobId	string (uuid)	ID del processo.
properties.jobRuntimeEnvironment	JobRuntimeEnvironment	Runtime Environment, proprietà
properties.lastModifiedTime	string (date-time)	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 (date-time)	Ora di inizio del processo.
properties.startedBy	string	Ottiene o imposta il processo avviato da .
properties.status	JobStatus	Stato del processo.
systemData	systemData	Metadati di Azure Resource Manager contenenti le informazioni createdBy e modifiedBy.
type	string	Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

JobListResultV2

Oggetto

Modello di risposta per l'operazione di elenco del processo.

Nome	Tipo	Descrizione
nextLink	string (uri)	Collegamento alla pagina successiva di elementi
value	JobCollectionItem[]	Gli elementi JobCollectionItem presenti in questa pagina

JobRuntimeEnvironment

Oggetto

Proprietà del runbook associata all'entità.

Nome	Tipo	Descrizione
runtimeEnvironmentName	string	Nome dell'ambiente di runtime.

JobStatus

Enumerazione

Ottiene o imposta lo stato del processo.

Valore	Descrizione
New	Nuova
Activating	Attivatore
Running	In esecuzione
Completed	Finito
Failed	Non riuscito
Stopped	Fermato
Blocked	Blocked
Suspended	Sospeso
Disconnected	Scollegato
Suspending	Sospensione
Stopping	Arresto in corso
Resuming	Ripresa
Removing	Rimozione

RunbookAssociationProperty

Oggetto

Proprietà del runbook associata all'entità.

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

systemData

Oggetto

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string (date-time)	Timestamp della creazione della risorsa (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string (date-time)	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.