Job Schedule - Create

Referência

Serviço:: Automation

Versão da API:: 2023-11-01

Criar uma agenda de tarefas.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
automationAccountName	path	True	string	O nome da conta de automatização.
jobScheduleId	path	True	string uuid	O nome do agendamento da tarefa.
resourceGroupName	path	True	string	Nome de um grupo de Recursos do Azure. Padrão Regex: `^[-\w\._]+$`
subscriptionId	path	True	string	Obtém credenciais de subscrição que identificam exclusivamente a subscrição do Microsoft Azure. O ID da subscrição faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão da API do Cliente.

Corpo do Pedido

Name	Necessário	Tipo	Description
properties.runbook	True	RunbookAssociationProperty	Obtém ou define o runbook.
properties.schedule	True	ScheduleAssociationProperty	Obtém ou define a agenda.
properties.parameters		object	Obtém ou define uma lista de propriedades da tarefa.
properties.runOn		string	Obtém ou define o grupo de trabalho híbrido no qual a tarefa agendada deve ser executada.

Respostas

Name	Tipo	Description
201 Created	JobSchedule	Criado
Other Status Codes	ErrorResponse	Resposta de erro de automatização que descreve o motivo pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

Create a job schedule

Pedido de amostra

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"
    }
  }
}

Resposta da amostra

Código de estado:: 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"
    }
  }
}

Definições

Name	Description
ErrorResponse	Resposta de erro de uma falha de operação
JobSchedule	Definição da agenda de tarefas.
JobScheduleCreateParameters	Os parâmetros fornecidos para a operação de criação de agendamento de tarefas.
RunbookAssociationProperty	A propriedade runbook associada à entidade.
ScheduleAssociationProperty	A propriedade schedule associada à entidade.

ErrorResponse

Resposta de erro de uma falha de operação

Name	Tipo	Description
code	string	Código de erro
message	string	Mensagem de erro a indicar o motivo pela qual a operação falhou.

JobSchedule

Definição da agenda de tarefas.

Name	Tipo	Description
id	string	Obtém o ID do recurso.
name	string	Obtém o nome da variável.
properties.jobScheduleId	string	Obtém ou define o ID da agenda de tarefas.
properties.parameters	object	Obtém ou define os parâmetros da agenda de tarefas.
properties.runOn	string	Obtém ou define o grupo de trabalho híbrido no qual a tarefa agendada deve ser executada.
properties.runbook	RunbookAssociationProperty	Obtém ou define o runbook.
properties.schedule	ScheduleAssociationProperty	Obtém ou define a agenda.
type	string	Tipo de recurso

JobScheduleCreateParameters

Os parâmetros fornecidos para a operação de criação de agendamento de tarefas.

Name	Tipo	Description
properties.parameters	object	Obtém ou define uma lista de propriedades da tarefa.
properties.runOn	string	Obtém ou define o grupo de trabalho híbrido no qual a tarefa agendada deve ser executada.
properties.runbook	RunbookAssociationProperty	Obtém ou define o runbook.
properties.schedule	ScheduleAssociationProperty	Obtém ou define a agenda.

RunbookAssociationProperty

A propriedade runbook associada à entidade.

Name	Tipo	Description
name	string	Obtém ou define o nome do runbook.

ScheduleAssociationProperty

A propriedade schedule associada à entidade.

Name	Tipo	Description
name	string	Obtém ou define o nome da Agenda.

Partilhar via