Job Schedule - Create

Service:

Automation

Version d'API:

2023-11-01

Créez une planification de travail.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
automationAccountName	path	True	string	Nom du compte Automation.
jobScheduleId	path	True	string (uuid)	Nom de la planification 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 de chaque appel de service.
api-version	query	True	string	Version de l’API cliente.

Corps de la demande

Nom	Obligatoire	Type	Description
properties.runbook	True	RunbookAssociationProperty	Obtient ou définit le runbook.
properties.schedule	True	ScheduleAssociationProperty	Obtient ou définit la planification.
properties.parameters		object	Obtient ou définit une liste de propriétés de travail.
properties.runOn		string	Obtient ou définit le groupe worker hybride sur lequel le travail planifié doit s’exécuter.

Réponses

Nom	Type	Description
201 Created	JobSchedule	Créé
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 a job schedule

Exemple de requête

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/jobSchedules/0fa462ba-3aa2-4138-83ca-9ebc3bc55cdc?api-version=2023-11-01

{
  "properties": {
    "schedule": {
      "name": "ScheduleNameGoesHere332204b5-debe-4348-a5c7-6357457189f2"
    },
    "runbook": {
      "name": "TestRunbook"
    },
    "parameters": {
      "jobscheduletag01": "jobschedulevalue01",
      "jobscheduletag02": "jobschedulevalue02"
    }
  }
}

Exemple de réponse

Code d’état:

201

{
  "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/jobSchedules/0fa462ba-3aa2-4138-83ca-9ebc3bc55cdc",
  "properties": {
    "jobScheduleId": "0fa462ba-3aa2-4138-83ca-9ebc3bc55cdc",
    "runbook": {
      "name": "TestRunbook"
    },
    "schedule": {
      "name": "ScheduleNameGoesHere332204b5-debe-4348-a5c7-6357457189f2"
    },
    "runOn": null,
    "parameters": {
      "jobscheduletag01": "jobschedulevalue01",
      "jobscheduletag02": "jobschedulevalue02"
    }
  }
}

Définitions

Nom	Description
ErrorResponse	Réponse d’erreur d’un échec d’opération
JobSchedule	Définition de la planification du travail.
JobScheduleCreateParameters	Paramètres fournis pour l’opération de planification de tâche de création.
RunbookAssociationProperty	Propriété runbook associée à l’entité.
ScheduleAssociationProperty	Propriété de planification associée à l’entité.

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é.

JobSchedule

Object

Définition de la planification du travail.

Nom	Type	Description
id	string	Obtient l’ID de la ressource.
name	string	Obtient le nom de la variable.
properties.jobScheduleId	string	Obtient ou définit l’ID de la planification du travail.
properties.parameters	object	Obtient ou définit les paramètres de la planification du travail.
properties.runOn	string	Obtient ou définit le groupe worker hybride sur lequel le travail planifié doit s’exécuter.
properties.runbook	RunbookAssociationProperty	Obtient ou définit le runbook.
properties.schedule	ScheduleAssociationProperty	Obtient ou définit la planification.
type	string	Type de ressource

JobScheduleCreateParameters

Object

Paramètres fournis pour l’opération de planification de tâche de création.

Nom	Type	Description
properties.parameters	object	Obtient ou définit une liste de propriétés de travail.
properties.runOn	string	Obtient ou définit le groupe worker hybride sur lequel le travail planifié doit s’exécuter.
properties.runbook	RunbookAssociationProperty	Obtient ou définit le runbook.
properties.schedule	ScheduleAssociationProperty	Obtient ou définit la planification.

RunbookAssociationProperty

Object

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

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

ScheduleAssociationProperty

Object

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

Nom	Type	Description
name	string	Obtient ou définit le nom de la planification.