Job - Create

Service:: Automation

Version d'API:: 2024-10-23

Créez un travail du runbook.

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

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 minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Nom d’un groupe de ressources Azure.
subscriptionId	path	True	string	Obtient les informations d’identification d’abonnement qui identifient de manière unique l’abonnement Microsoft Azure. 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 de client 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 l’runOn qui spécifie le nom du groupe où 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 pourquoi l’opération a échoué.

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

HTTP

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

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

Exemple de réponse

Code d’état:: 201

{
  "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": "",
    "jobRuntimeEnvironment": {
      "runtimeEnvironmentName": "environmentName"
    }
  }
}

Définitions

Nom	Description
createdByType	Type d’identité qui a créé la ressource.
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 de travail.
JobProvisioningState	État d’approvisionnement actuel du travail.
JobRuntimeEnvironment	Propriété runbook associée à l’entité.
JobStatus	Obtient ou définit l’état du travail.
RunbookAssociationProperty	Propriété runbook associée à l’entité.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
User
Application
ManagedIdentity
Key

ErrorResponse

Object

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

Nom	Type	Description
code	string	Code d’erreur
message	string	Message d’erreur indiquant pourquoi l’opération a échoué.

Job

Object

Définition du travail.

Nom	Type	Description
id	string (arm-id)	ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »
name	string	Nom de la ressource
properties.creationTime	string (date-time)	Obtient ou définit l’heure de création du travail.
properties.endTime	string (date-time)	Obtient ou définit l’heure de fin du travail.
properties.exception	string	Obtient ou définit l’exception du travail.
properties.jobId	string (uuid)	Obtient ou définit l’ID du travail.
properties.jobRuntimeEnvironment	JobRuntimeEnvironment	Runtime Environment, propriété
properties.lastModifiedTime	string (date-time)	Obtient ou définit l’heure de dernière modification du travail.
properties.lastStatusModifiedTime	string (date-time)	Obtient ou définit l’heure de dernière modification de l’état 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 l’runOn qui spécifie le nom du groupe où le travail doit être exécuté.
properties.runbook	RunbookAssociationProperty	Obtient ou définit le runbook.
properties.startTime	string (date-time)	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 l’état du travail.
properties.statusDetails	string	Obtient ou définit les détails de l’état du travail.
systemData	systemData	Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

JobCreateParameters

Object

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

Nom	Type	Description
properties.parameters	object	Obtient ou définit les paramètres du travail.
properties.runOn	string	Obtient ou définit l’runOn qui spécifie le nom du groupe où le travail doit être exécuté.
properties.runbook	RunbookAssociationProperty	Obtient ou définit le runbook.

JobProvisioningState

Énumération

État d’approvisionnement actuel du travail.

Valeur	Description
Failed
Succeeded
Suspended
Processing

JobRuntimeEnvironment

Object

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

Nom	Type	Description
runtimeEnvironmentName	string	Nom de l’environnement d’exécution.

JobStatus

Énumération

Obtient ou définit l’état du travail.

Valeur	Description
New
Activating
Running
Completed
Failed
Stopped
Blocked
Suspended
Disconnected
Suspending
Stopping
Resuming
Removing

RunbookAssociationProperty

Object

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

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

systemData

Object

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.

Partager via

Job - Create

Paramètres URI

En-tête de la demande

Corps de la demande

Réponses

Sécurité

azure_auth

Étendues

Exemples

Create job

Exemple de requête

Exemple de réponse

Définitions

createdByType

ErrorResponse

Job

JobCreateParameters

JobProvisioningState

JobRuntimeEnvironment

JobStatus

RunbookAssociationProperty

systemData