Runbook - Get

Referencia

Servicio:: Automation

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

Recupere el runbook identificado por el nombre del runbook.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}?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.
resourceGroupName	path	True	string	Nombre de un grupo de recursos de Azure. Patrón de Regex: `^[-\w\._]+$`
runbookName	path	True	string	Nombre del runbook. Patrón de Regex: `^[a-zA-Z][a-zA-Z-_0-9]*$`
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.

Respuestas

Nombre	Tipo	Description
200 OK	Runbook	Aceptar
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

Get runbook

Solicitud de ejemplo

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/runbooks/Get-AzureVMTutorial?api-version=2023-11-01

Respuesta de muestra

status code:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/runbooks/Get-AzureVMTutorial",
  "name": "Get-AzureVMTutorial",
  "type": "Microsoft.Automation/AutomationAccounts/Runbooks",
  "location": "East US 2",
  "tags": {
    "tag01": "value01",
    "tag02": "value02"
  },
  "etag": "\"636263335437500000\"",
  "properties": {
    "description": "Description of the Runbook",
    "logVerbose": false,
    "logProgress": true,
    "logActivityTrace": 1,
    "runbookType": "PowerShellWorkflow",
    "parameters": {},
    "state": "Published",
    "jobCount": 0,
    "provisioningState": "Succeeded",
    "outputTypes": [],
    "creationTime": "2017-03-28T21:32:23.75+00:00",
    "lastModifiedBy": "myEmaild@microsoft.com",
    "lastModifiedTime": "2017-03-28T21:32:23.75+00:00"
  }
}

Definiciones

Nombre	Description
ContentHash	Definición del tipo de propiedad runbook.
ContentLink	Definición del vínculo de contenido.
ErrorResponse	Respuesta de error de un error de operación
Runbook	Definición del tipo de runbook.
RunbookDraft
RunbookParameter	Definición del tipo de parámetro runbook.
RunbookProvisioningState	Obtiene o establece el estado de aprovisionamiento del runbook.
RunbookState	Obtiene o establece el estado del runbook.
RunbookTypeEnum	Obtiene o establece el tipo del runbook.

ContentHash

Definición del tipo de propiedad runbook.

Nombre	Tipo	Description
algorithm	string	Obtiene o establece el algoritmo hash de contenido usado para aplicar un hash al contenido.
value	string	Obtiene o establece el valor hash esperado del contenido.

ContentLink

Definición del vínculo de contenido.

Nombre	Tipo	Description
contentHash	ContentHash	Establece el hash.
uri	string	Establece el URI del contenido.
version	string	Establece la versión del contenido.

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.

Runbook

Definición del tipo de runbook.

Nombre	Tipo	Description
etag	string	Obtiene o establece la etag del recurso.
id	string	Identificador de recurso completo para el recurso
location	string	Región de Azure donde reside el recurso
name	string	Nombre del recurso.
properties.creationTime	string	Obtiene o establece la hora de creación.
properties.description	string	Obtiene o establece la descripción.
properties.draft	RunbookDraft	Obtiene o establece las propiedades del runbook de borrador.
properties.jobCount	integer	Obtiene o establece el número de trabajos del runbook.
properties.lastModifiedBy	string	Obtiene o establece el último modificado por.
properties.lastModifiedTime	string	Obtiene o establece la hora de la última modificación.
properties.logActivityTrace	integer	Obtiene o establece la opción para registrar el seguimiento de actividad del runbook.
properties.logProgress	boolean	Obtiene o establece la opción de registro de progreso.
properties.logVerbose	boolean	Obtiene o establece la opción de registro detallado.
properties.outputTypes	string[]	Obtiene o establece los tipos de salida del runbook.
properties.parameters	<string, RunbookParameter>	Obtiene o establece los parámetros del runbook.
properties.provisioningState	RunbookProvisioningState	Obtiene o establece el estado de aprovisionamiento del runbook.
properties.publishContentLink	ContentLink	Obtiene o establece el vínculo de contenido del runbook publicado.
properties.runbookType	RunbookTypeEnum	Obtiene o establece el tipo del runbook.
properties.state	RunbookState	Obtiene o establece el estado del runbook.
tags	object	Etiquetas del recurso.
type	string	Tipo de recurso.

RunbookDraft

Nombre	Tipo	Description
creationTime	string	Obtiene o establece la hora de creación del borrador del runbook.
draftContentLink	ContentLink	Obtiene o establece el vínculo de contenido del runbook de borrador.
inEdit	boolean	Obtiene o establece si el runbook está en modo de edición.
lastModifiedTime	string	Obtiene o establece la hora de la última modificación del borrador del runbook.
outputTypes	string[]	Obtiene o establece los tipos de salida del runbook.
parameters	<string, RunbookParameter>	Obtiene o establece los parámetros de borrador del runbook.

RunbookParameter

Definición del tipo de parámetro runbook.

Nombre	Tipo	Description
defaultValue	string	Obtiene o establece el valor predeterminado del parámetro .
isMandatory	boolean	Obtiene o establece un valor booleano para indicar si el parámetro es obligatorio o no.
position	integer	Obtiene o establece la posición del parámetro .
type	string	Obtiene o establece el tipo de parámetro.

RunbookProvisioningState

Obtiene o establece el estado de aprovisionamiento del runbook.

Nombre	Tipo	Description
Succeeded	string

RunbookState

Obtiene o establece el estado del runbook.

Nombre	Tipo	Description
Edit	string
New	string
Published	string

RunbookTypeEnum

Obtiene o establece el tipo del runbook.

Nombre	Tipo	Description
Graph	string
GraphPowerShell	string
GraphPowerShellWorkflow	string
PowerShell	string
PowerShell72	string
PowerShellWorkflow	string
Python2	string
Python3	string
Script	string

Compartir a través de