Partager via


Job - Create

Créez un travail du runbook.

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

Paramètres URI

Nom Dans Obligatoire Type Description
automationAccountName
path True

string

Nom du compte Automation.

jobName
path True

string

Nom du travail.

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.

En-tête de la demande

Nom Obligatoire Type Description
clientRequestId

string

Identifie cette demande cliente spécifique.

Corps de la demande

Nom Type Description
properties.parameters

object

Obtient ou définit les paramètres du travail.

properties.runOn

string

Obtient ou définit le runOn qui spécifie le nom du groupe dans lequel le travail doit être exécuté.

properties.runbook

RunbookAssociationProperty

Obtient ou définit le runbook.

Réponses

Nom Type Description
201 Created

Job

Date de création

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

Create job

Exemple de requête

PUT https://management.azure.com/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/jobs/foo?api-version=2023-11-01

{
  "properties": {
    "runbook": {
      "name": "TestRunbook"
    },
    "parameters": {
      "key01": "value01",
      "key02": "value02"
    },
    "runOn": ""
  }
}

Exemple de réponse

{
  "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/jobs/jobName",
  "name": "foo",
  "type": "Microsoft.Automation/AutomationAccounts/Jobs",
  "properties": {
    "jobId": "5b8a3960-e8ab-45f6-bec6-567df8467d1a",
    "runbook": {
      "name": "TestRunbook"
    },
    "provisioningState": "Processing",
    "creationTime": "2018-02-01T05:53:30.243+00:00",
    "endTime": null,
    "exception": null,
    "lastModifiedTime": "2018-02-01T05:53:30.243+00:00",
    "lastStatusModifiedTime": "2018-02-01T05:53:30.243+00:00",
    "startTime": null,
    "status": "New",
    "statusDetails": "None",
    "parameters": {
      "tag01": "value01",
      "tag02": "value02"
    },
    "runOn": ""
  }
}

Définitions

Nom Description
ErrorResponse

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

Job

Définition du travail.

JobCreateParameters

Paramètres fournis à l’opération de création du travail.

JobProvisioningState

État d’approvisionnement actuel du travail.

JobStatus

Obtient ou définit le 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.

Job

Définition du travail.

Nom Type Description
id

string

ID de ressource complet pour la ressource

name

string

nom de la ressource.

properties.creationTime

string

Obtient ou définit l’heure de création du travail.

properties.endTime

string

Obtient ou définit l’heure de fin du travail.

properties.exception

string

Obtient ou définit l’exception du travail.

properties.jobId

string

Obtient ou définit l’ID du travail.

properties.lastModifiedTime

string

Obtient ou définit l’heure de la dernière modification du travail.

properties.lastStatusModifiedTime

string

Obtient ou définit la dernière status heure de modification du travail.

properties.parameters

object

Obtient ou définit les paramètres du travail.

properties.provisioningState

JobProvisioningState

État d’approvisionnement actuel du travail.

properties.runOn

string

Obtient ou définit le runOn qui spécifie le nom du groupe dans lequel le travail doit être exécuté.

properties.runbook

RunbookAssociationProperty

Obtient ou définit le runbook.

properties.startTime

string

Obtient ou définit l’heure de début du travail.

properties.startedBy

string

Obtient ou définit le travail démarré par.

properties.status

JobStatus

Obtient ou définit le status du travail.

properties.statusDetails

string

Obtient ou définit le status détails du travail.

type

string

Type de la ressource.

JobCreateParameters

Paramètres fournis à l’opération de création du travail.

Nom Type Description
properties.parameters

object

Obtient ou définit les paramètres du travail.

properties.runOn

string

Obtient ou définit le runOn qui spécifie le nom du groupe dans lequel le travail doit être exécuté.

properties.runbook

RunbookAssociationProperty

Obtient ou définit le runbook.

JobProvisioningState

État d’approvisionnement actuel du travail.

Nom Type Description
Failed

string

Processing

string

Succeeded

string

Suspended

string

JobStatus

Obtient ou définit le 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.