Job Schedule - Create

Referência

Serviço:: Automation

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

Crie uma agenda de trabalho.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
automationAccountName	path	True	string	O nome da conta de automação.
jobScheduleId	path	True	string uuid	O nome do agendamento do trabalho.
resourceGroupName	path	True	string	Nome de um grupo de recursos do Azure. Padrão Regex: `^[-\w\._]+$`
subscriptionId	path	True	string	Obtém as credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão da API do cliente.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
properties.runbook	True	RunbookAssociationProperty	Obtém ou define o runbook.
properties.schedule	True	ScheduleAssociationProperty	Obtém ou define o agendamento.
properties.parameters		object	Obtém ou define uma lista de propriedades do trabalho.
properties.runOn		string	Obtém ou define o grupo de trabalho híbrido no qual o trabalho agendado deve ser executado.

Respostas

Nome	Tipo	Description
201 Created	JobSchedule	Criado
Other Status Codes	ErrorResponse	Resposta de erro de automação que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Create a job schedule

Solicitação de exemplo

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 de exemplo

Código de status:: 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

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

ErrorResponse

Resposta de erro de uma falha de operação

Nome	Tipo	Description
code	string	Código do erro
message	string	Mensagem de erro indicando por que a operação falhou.

JobSchedule

Definição da agenda de trabalho.

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

JobScheduleCreateParameters

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

Nome	Tipo	Description
properties.parameters	object	Obtém ou define uma lista de propriedades do trabalho.
properties.runOn	string	Obtém ou define o grupo de trabalho híbrido no qual o trabalho agendado deve ser executado.
properties.runbook	RunbookAssociationProperty	Obtém ou define o runbook.
properties.schedule	ScheduleAssociationProperty	Obtém ou define o agendamento.

RunbookAssociationProperty

A propriedade runbook associada à entidade .

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

ScheduleAssociationProperty

A propriedade schedule associada à entidade .

Nome	Tipo	Description
name	string	Obtém ou define o nome do Agendamento.

Compartilhar via