Job - List By Automation Account

Référence

Service:: Automation

Version d'API:: 2023-11-01

Récupérez une liste de travaux.

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

Avec des paramètres facultatifs:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
automationAccountName	path	True	string	Nom du compte Automation.
resourceGroupName	path	True	string	Nom d’un groupe de ressources Azure. Modèle d’expression régulière: `^[-\w\._]+$`
subscriptionId	path	True	string	Obtient les informations d'identification d'abonnement qui identifient l'abonnement Microsoft Azure de manière unique. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.
api-version	query	True	string	Version de l’API cliente.
$filter	query		string	Filtre à appliquer à l’opération.

En-tête de la demande

Nom	Obligatoire	Type	Description
clientRequestId		string	Identifie cette demande cliente spécifique.

Réponses

Nom	Type	Description
200 OK	JobListResultV2	Ok
Other Status Codes	ErrorResponse	Réponse d’erreur Automation décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

List jobs by automation account

Exemple de requête

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

Exemple de réponse

Code d’état:: 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
}

Définitions

Nom	Description
ErrorResponse	Réponse d’erreur d’un échec d’opération
JobCollectionItem	Propriétés de l’élément de collection de travaux.
JobListResultV2	Modèle de réponse pour l’opération de travail de liste.
JobStatus	Obtient ou définit la status du travail.
RunbookAssociationProperty	Propriété de runbook associée à l’entité.

ErrorResponse

Réponse d’erreur d’un échec d’opération

Nom	Type	Description
code	string	Code d'erreur
message	string	Message d’erreur indiquant la raison de l’échec de l’opération.

JobCollectionItem

Propriétés de l’élément de collection de travaux.

Nom	Type	Description
id	string	ID de ressource complet pour la ressource
name	string	nom de la ressource.
properties.creationTime	string	Heure de création du travail.
properties.endTime	string	Heure de fin du travail.
properties.jobId	string	ID du travail.
properties.lastModifiedTime	string	Heure de la dernière modification du travail.
properties.provisioningState	string	État d’approvisionnement d’une ressource.
properties.runOn	string	Spécifie le nom du groupe runOn dans lequel le travail a été exécuté.
properties.runbook	RunbookAssociationProperty	Association de runbooks.
properties.startTime	string	Heure de début du travail.
properties.status	JobStatus	État du travail.
type	string	Type de la ressource.

JobListResultV2

Modèle de réponse pour l’opération de travail de liste.

Nom	Type	Description
nextLink	string	Lien vers la page suivante.
value	JobCollectionItem[]	Liste des travaux.

JobStatus

Obtient ou définit la status du travail.

Nom	Type	Description
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

Propriété de runbook associée à l’entité.

Nom	Type	Description
name	string	Obtient ou définit le nom du runbook.

Partager via