Job - Create

Referencia

Servicio:: Automation

Versión de la API:: 2023-11-01

Cree un trabajo del runbook.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
automationAccountName	path	True	string	Nombre de la cuenta de Automation.
jobName	path	True	string	Nombre del trabajo.
resourceGroupName	path	True	string	Nombre de un grupo de recursos de Azure. Patrón de Regex: `^[-\w\._]+$`
subscriptionId	path	True	string	Obtiene las credenciales de suscripción que identifican a la suscripción de Microsoft Azure de forma única. El identificador de suscripción forma parte del URI para cada llamada al servicio.
api-version	query	True	string	Versión de api de cliente.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
clientRequestId		string	Identifica esta solicitud de cliente específica.

Cuerpo de la solicitud

Nombre	Tipo	Description
properties.parameters	object	Obtiene o establece los parámetros del trabajo.
properties.runOn	string	Obtiene o establece el runOn que especifica el nombre del grupo donde se va a ejecutar el trabajo.
properties.runbook	RunbookAssociationProperty	Obtiene o establece el runbook.

Respuestas

Nombre	Tipo	Description
201 Created	Job	Creado
Other Status Codes	ErrorResponse	Respuesta de error de Automatización que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

Create job

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 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": ""
  }
}

Definiciones

Nombre	Description
ErrorResponse	Respuesta de error de un error de operación
Job	Definición del trabajo.
JobCreateParameters	Parámetros proporcionados a la operación de creación del trabajo.
JobProvisioningState	Estado de aprovisionamiento actual del trabajo.
JobStatus	Obtiene o establece el estado del trabajo.
RunbookAssociationProperty	Propiedad runbook asociada a la entidad.

ErrorResponse

Respuesta de error de un error de operación

Nombre	Tipo	Description
code	string	Código de error
message	string	Mensaje de error que indica por qué se produjo un error en la operación.

Job

Definición del trabajo.

Nombre	Tipo	Description
id	string	Identificador de recurso completo para el recurso
name	string	Nombre del recurso.
properties.creationTime	string	Obtiene o establece la hora de creación del trabajo.
properties.endTime	string	Obtiene o establece la hora de finalización del trabajo.
properties.exception	string	Obtiene o establece la excepción del trabajo.
properties.jobId	string	Obtiene o establece el identificador del trabajo.
properties.lastModifiedTime	string	Obtiene o establece la hora de la última modificación del trabajo.
properties.lastStatusModifiedTime	string	Obtiene o establece la hora de última modificación del estado del trabajo.
properties.parameters	object	Obtiene o establece los parámetros del trabajo.
properties.provisioningState	JobProvisioningState	Estado de aprovisionamiento actual del trabajo.
properties.runOn	string	Obtiene o establece el runOn que especifica el nombre del grupo donde se va a ejecutar el trabajo.
properties.runbook	RunbookAssociationProperty	Obtiene o establece el runbook.
properties.startTime	string	Obtiene o establece la hora de inicio del trabajo.
properties.startedBy	string	Obtiene o establece el trabajo iniciado por.
properties.status	JobStatus	Obtiene o establece el estado del trabajo.
properties.statusDetails	string	Obtiene o establece los detalles de estado del trabajo.
type	string	Tipo de recurso.

JobCreateParameters

Parámetros proporcionados a la operación de creación del trabajo.

Nombre	Tipo	Description
properties.parameters	object	Obtiene o establece los parámetros del trabajo.
properties.runOn	string	Obtiene o establece el runOn que especifica el nombre del grupo donde se va a ejecutar el trabajo.
properties.runbook	RunbookAssociationProperty	Obtiene o establece el runbook.

JobProvisioningState

Estado de aprovisionamiento actual del trabajo.

Nombre	Tipo	Description
Failed	string
Processing	string
Succeeded	string
Suspended	string

JobStatus

Obtiene o establece el estado del trabajo.

Nombre	Tipo	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

Propiedad runbook asociada a la entidad.

Nombre	Tipo	Description
name	string	Obtiene o establece el nombre del runbook.

Compartir a través de