Job - Create

Servicio:: Automation

Versión de la API:: 2024-10-23

Cree un trabajo del runbook.

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

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 minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version	query	True	string minLength: 1	Versión de API que se usará para la operación.

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	Operación de creación de 'Trabajo' de recurso exitosa
Other Status Codes	ErrorResponse	Una respuesta de error inesperada.

Seguridad

azure_auth

Flujo de 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	suplantar la 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=2024-10-23

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

Respuesta de muestra

status code:: 201

{
  "name": "foo",
  "type": "Microsoft.Automation/AutomationAccounts/Jobs",
  "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/jobs/jobName",
  "properties": {
    "creationTime": "2018-02-01T05:53:30.243+00:00",
    "endTime": null,
    "exception": null,
    "jobId": "5b8a3960-e8ab-45f6-bec6-567df8467d1a",
    "jobRuntimeEnvironment": {
      "runtimeEnvironmentName": "environmentName"
    },
    "lastModifiedTime": "2018-02-01T05:53:30.243+00:00",
    "lastStatusModifiedTime": "2018-02-01T05:53:30.243+00:00",
    "parameters": {
      "tag01": "value01",
      "tag02": "value02"
    },
    "provisioningState": "Processing",
    "runOn": "",
    "runbook": {
      "name": "TestRunbook"
    },
    "startTime": null,
    "status": "New",
    "statusDetails": "None"
  }
}

Definiciones

Nombre	Description
createdByType	Tipo de identidad que creó el recurso.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
Job	Definición del trabajo.
JobCreateParameters	Parámetros proporcionados a la operación de creación del trabajo.
JobProvisioningState	Estado de aprovisionamiento del recurso.
JobRuntimeEnvironment	La propiedad runbook asociada a la entidad.
JobStatus	Obtiene o establece el estado del trabajo.
RunbookAssociationProperty	La propiedad runbook asociada a la entidad.
systemData	Metadatos relativos a la creación y última modificación del recurso.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objeto

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Objeto

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Objeto

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

Job

Objeto

Definición del trabajo.

Nombre	Tipo	Description
id	string (arm-id)	Identificador de recurso completo para el recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nombre del recurso
properties.creationTime	string (date-time)	Obtiene o establece la hora de creación del trabajo.
properties.endTime	string (date-time)	Obtiene o establece la hora de finalización del trabajo.
properties.exception	string	Obtiene o establece la excepción del trabajo.
properties.jobId	string (uuid)	Obtiene o establece el identificador del trabajo.
properties.jobRuntimeEnvironment	JobRuntimeEnvironment	Runtime Environment (propiedad)
properties.lastModifiedTime	string (date-time)	Obtiene o establece la hora de última modificación del trabajo.
properties.lastStatusModifiedTime	string (date-time)	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 (date-time)	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.
systemData	systemData	Metadatos de Azure Resource Manager que contienen información createdBy y modifiedBy.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

JobCreateParameters

Objeto

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

Enumeración

Estado de aprovisionamiento del recurso.

Valor	Description
Failed	Fallido
Succeeded	Succeeded
Suspended	Suspendido
Processing	Processing

JobRuntimeEnvironment

Objeto

La propiedad runbook asociada a la entidad.

Nombre	Tipo	Description
runtimeEnvironmentName	string	Nombre del entorno en tiempo de ejecución.

JobStatus

Enumeración

Obtiene o establece el estado del trabajo.

Valor	Description
New	Nuevo
Activating	Activador
Running	Correr
Completed	Completado
Failed	Fallido
Stopped	Detenido
Blocked	Blocked
Suspended	Suspendido
Disconnected	Desconectado
Suspending	Suspendiendo
Stopping	Parar
Resuming	Reanudar
Removing	Quitar

RunbookAssociationProperty

Objeto

La propiedad runbook asociada a la entidad.

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

systemData

Objeto

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.