Microsoft.Automation automationAccounts/runbooks

Artículo
12/16/2024

Definición de recursos de Bicep

El tipo de recurso automationAccounts/runbooks se puede implementar con operaciones destinadas a:

grupos de recursos: consulte comandos de implementación de grupos de recursos

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.Automation/automationAccounts/runbooks, agregue el siguiente bicep a la plantilla.

resource symbolicname 'Microsoft.Automation/automationAccounts/runbooks@2024-10-23' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    description: 'string'
    draft: {
      creationTime: 'string'
      draftContentLink: {
        contentHash: {
          algorithm: 'string'
          value: 'string'
        }
        uri: 'string'
        version: 'string'
      }
      inEdit: bool
      lastModifiedTime: 'string'
      outputTypes: [
        'string'
      ]
      parameters: {
        {customized property}: {
          defaultValue: 'string'
          isMandatory: bool
          position: int
          type: 'string'
        }
      }
    }
    logActivityTrace: int
    logProgress: bool
    logVerbose: bool
    publishContentLink: {
      contentHash: {
        algorithm: 'string'
        value: 'string'
      }
      uri: 'string'
      version: 'string'
    }
    runbookType: 'string'
    runtimeEnvironment: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valores de propiedad

ContentHash

Nombre	Descripción	Valor
algoritmo	Obtiene o establece el algoritmo hash de contenido utilizado para aplicar un hash al contenido.	string (obligatorio)
valor	Obtiene o establece el valor hash esperado del contenido.	string (obligatorio)

ContentLink

Nombre	Descripción	Valor
contentHash	Obtiene o establece el hash.	contentHash de
Uri	Obtiene o establece el URI del contenido.	cuerda
Versión	Obtiene o establece la versión del contenido.	cuerda

Microsoft.Automation/automationAccounts/runbooks

Nombre	Descripción	Valor
ubicación	Obtiene o establece la ubicación del recurso.	cuerda
nombre	El nombre del recurso	cuerda Restricciones: Patrón = `^[a-zA-Z][a-zA-Z-_0-9]*$` (obligatorio)
padre	En Bicep, puede especificar el recurso primario para un recurso secundario. Solo tiene que agregar esta propiedad cuando el recurso secundario se declara fuera del recurso primario. Para obtener más información, consulte recurso secundario fuera del recurso primario.	Nombre simbólico del recurso de tipo: automationAccounts
Propiedades	Obtiene o establece las propiedades de creación o actualización del runbook.	RunbookCreateOrUpdatePropertiesOrRunbookProperties (obligatorio)
Etiquetas	Etiquetas de recursos	Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas

RunbookCreateOrUpdateParametersTags

Nombre	Descripción	Valor

RunbookCreateOrUpdatePropertiesOrRunbookProperties

Nombre	Descripción	Valor
descripción	Obtiene o establece la descripción del runbook.	cuerda
corriente de aire	Obtiene o establece las propiedades del runbook borrador.	RunbookDraft
logActivityTrace	Obtiene o establece las opciones de seguimiento de nivel de actividad del runbook.	Int
logProgress	Obtiene o establece la opción de registro de progreso.	Bool
logVerbose	Obtiene o establece la opción de registro detallado.	Bool
publishContentLink	Obtiene o establece el vínculo de contenido del runbook publicado.	ContentLink
runbookType	Obtiene o establece el tipo del runbook.	'Graph' 'GraphPowerShell' 'GraphPowerShellWorkflow' 'PowerShell' 'PowerShell72' 'PowerShellWorkflow' 'Python' 'Python2' 'Python3' 'Script' (obligatorio)
runtimeEnvironment	Entorno del runbook.	cuerda

RunbookDraft

Nombre	Descripción	Valor
creationTime	Obtiene o establece la hora de creación del borrador del runbook.	cuerda
draftContentLink	Obtiene o establece el vínculo de contenido del runbook borrador.	ContentLink
inEdit	Obtiene o establece si el runbook está en modo de edición.	Bool
lastModifiedTime	Obtiene o establece la hora de última modificación del borrador del runbook.	cuerda
outputTypes	Obtiene o establece los tipos de salida del runbook.	string[]
Parámetros	Obtiene o establece los parámetros de borrador del runbook.	runbookDraftParameters

RunbookDraftParameters

Nombre	Descripción	Valor

RunbookParameter

Nombre	Descripción	Valor
defaultValue	Obtiene o establece el valor predeterminado del parámetro.	cuerda
isMandatory	Obtiene o establece un valor booleano para indicar si el parámetro es obligatorio o no.	Bool
posición	Obtiene o establece la posición del parámetro.	Int
tipo	Obtiene o establece el tipo del parámetro .	cuerda

Ejemplos de inicio rápido

En los ejemplos de inicio rápido siguientes se implementa este tipo de recurso.

Archivo de Bicep	Descripción
runbooks de ASR de	Implementa runbooks de Automation para planes de recuperación de ASR

Definición de recursos de plantilla de ARM

El tipo de recurso automationAccounts/runbooks se puede implementar con operaciones destinadas a:

grupos de recursos: consulte comandos de implementación de grupos de recursos

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.Automation/automationAccounts/runbooks, agregue el siguiente JSON a la plantilla.

{
  "type": "Microsoft.Automation/automationAccounts/runbooks",
  "apiVersion": "2024-10-23",
  "name": "string",
  "location": "string",
  "properties": {
    "description": "string",
    "draft": {
      "creationTime": "string",
      "draftContentLink": {
        "contentHash": {
          "algorithm": "string",
          "value": "string"
        },
        "uri": "string",
        "version": "string"
      },
      "inEdit": "bool",
      "lastModifiedTime": "string",
      "outputTypes": [ "string" ],
      "parameters": {
        "{customized property}": {
          "defaultValue": "string",
          "isMandatory": "bool",
          "position": "int",
          "type": "string"
        }
      }
    },
    "logActivityTrace": "int",
    "logProgress": "bool",
    "logVerbose": "bool",
    "publishContentLink": {
      "contentHash": {
        "algorithm": "string",
        "value": "string"
      },
      "uri": "string",
      "version": "string"
    },
    "runbookType": "string",
    "runtimeEnvironment": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valores de propiedad

ContentHash

Nombre	Descripción	Valor
algoritmo	Obtiene o establece el algoritmo hash de contenido utilizado para aplicar un hash al contenido.	string (obligatorio)
valor	Obtiene o establece el valor hash esperado del contenido.	string (obligatorio)

ContentLink

Nombre	Descripción	Valor
contentHash	Obtiene o establece el hash.	contentHash de
Uri	Obtiene o establece el URI del contenido.	cuerda
Versión	Obtiene o establece la versión del contenido.	cuerda

Microsoft.Automation/automationAccounts/runbooks

Nombre	Descripción	Valor
apiVersion	La versión de api	'2024-10-23'
ubicación	Obtiene o establece la ubicación del recurso.	cuerda
nombre	El nombre del recurso	cuerda Restricciones: Patrón = `^[a-zA-Z][a-zA-Z-_0-9]*$` (obligatorio)
Propiedades	Obtiene o establece las propiedades de creación o actualización del runbook.	RunbookCreateOrUpdatePropertiesOrRunbookProperties (obligatorio)
Etiquetas	Etiquetas de recursos	Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas
tipo	El tipo de recurso	"Microsoft.Automation/automationAccounts/runbooks"

RunbookCreateOrUpdateParametersTags

Nombre	Descripción	Valor

RunbookCreateOrUpdatePropertiesOrRunbookProperties

Nombre	Descripción	Valor
descripción	Obtiene o establece la descripción del runbook.	cuerda
corriente de aire	Obtiene o establece las propiedades del runbook borrador.	RunbookDraft
logActivityTrace	Obtiene o establece las opciones de seguimiento de nivel de actividad del runbook.	Int
logProgress	Obtiene o establece la opción de registro de progreso.	Bool
logVerbose	Obtiene o establece la opción de registro detallado.	Bool
publishContentLink	Obtiene o establece el vínculo de contenido del runbook publicado.	ContentLink
runbookType	Obtiene o establece el tipo del runbook.	'Graph' 'GraphPowerShell' 'GraphPowerShellWorkflow' 'PowerShell' 'PowerShell72' 'PowerShellWorkflow' 'Python' 'Python2' 'Python3' 'Script' (obligatorio)
runtimeEnvironment	Entorno del runbook.	cuerda

RunbookDraft

Nombre	Descripción	Valor
creationTime	Obtiene o establece la hora de creación del borrador del runbook.	cuerda
draftContentLink	Obtiene o establece el vínculo de contenido del runbook borrador.	ContentLink
inEdit	Obtiene o establece si el runbook está en modo de edición.	Bool
lastModifiedTime	Obtiene o establece la hora de última modificación del borrador del runbook.	cuerda
outputTypes	Obtiene o establece los tipos de salida del runbook.	string[]
Parámetros	Obtiene o establece los parámetros de borrador del runbook.	runbookDraftParameters

RunbookDraftParameters

Nombre	Descripción	Valor

RunbookParameter

Nombre	Descripción	Valor
defaultValue	Obtiene o establece el valor predeterminado del parámetro.	cuerda
isMandatory	Obtiene o establece un valor booleano para indicar si el parámetro es obligatorio o no.	Bool
posición	Obtiene o establece la posición del parámetro.	Int
tipo	Obtiene o establece el tipo del parámetro .	cuerda

Plantillas de inicio rápido

Las siguientes plantillas de inicio rápido implementan este tipo de recurso.

Plantilla

Descripción

runbooks de ASR de

Implementa runbooks de Automation para planes de recuperación de ASR

Azure Resource Optimization (ARO) Toolkit

Azure Resource Optimization Toolkit es una solución de Azure descentralizada nativa que usa tecnologías sin servidor para optimizar los recursos de Azure en su suscripción. La optimización se produce automáticamente en la suscripción una vez que habilite o cree su propia programación, incluidos los nuevos recursos. Se trata de una cuenta de Azure Automation con runbooks preconfigurados y programaciones que puede usar en su suscripción para empezar a ahorrar dinero.

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso automationAccounts/runbooks se puede implementar con operaciones destinadas a:

grupos de recursos de

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.Automation/automationAccounts/runbooks, agregue el siguiente terraform a la plantilla.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Automation/automationAccounts/runbooks@2024-10-23"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      description = "string"
      draft = {
        creationTime = "string"
        draftContentLink = {
          contentHash = {
            algorithm = "string"
            value = "string"
          }
          uri = "string"
          version = "string"
        }
        inEdit = bool
        lastModifiedTime = "string"
        outputTypes = [
          "string"
        ]
        parameters = {
          {customized property} = {
            defaultValue = "string"
            isMandatory = bool
            position = int
            type = "string"
          }
        }
      }
      logActivityTrace = int
      logProgress = bool
      logVerbose = bool
      publishContentLink = {
        contentHash = {
          algorithm = "string"
          value = "string"
        }
        uri = "string"
        version = "string"
      }
      runbookType = "string"
      runtimeEnvironment = "string"
    }
  })
}

Valores de propiedad

ContentHash

Nombre	Descripción	Valor
algoritmo	Obtiene o establece el algoritmo hash de contenido utilizado para aplicar un hash al contenido.	string (obligatorio)
valor	Obtiene o establece el valor hash esperado del contenido.	string (obligatorio)

ContentLink

Nombre	Descripción	Valor
contentHash	Obtiene o establece el hash.	contentHash de
Uri	Obtiene o establece el URI del contenido.	cuerda
Versión	Obtiene o establece la versión del contenido.	cuerda

Microsoft.Automation/automationAccounts/runbooks

Nombre	Descripción	Valor
ubicación	Obtiene o establece la ubicación del recurso.	cuerda
nombre	El nombre del recurso	cuerda Restricciones: Patrón = `^[a-zA-Z][a-zA-Z-_0-9]*$` (obligatorio)
parent_id	Identificador del recurso que es el elemento primario de este recurso.	Identificador del recurso de tipo: automationAccounts
Propiedades	Obtiene o establece las propiedades de creación o actualización del runbook.	RunbookCreateOrUpdatePropertiesOrRunbookProperties (obligatorio)
Etiquetas	Etiquetas de recursos	Diccionario de nombres y valores de etiqueta.
tipo	El tipo de recurso	"Microsoft.Automation/automationAccounts/runbooks@2024-10-23"

RunbookCreateOrUpdateParametersTags

Nombre	Descripción	Valor

RunbookCreateOrUpdatePropertiesOrRunbookProperties

Nombre	Descripción	Valor
descripción	Obtiene o establece la descripción del runbook.	cuerda
corriente de aire	Obtiene o establece las propiedades del runbook borrador.	RunbookDraft
logActivityTrace	Obtiene o establece las opciones de seguimiento de nivel de actividad del runbook.	Int
logProgress	Obtiene o establece la opción de registro de progreso.	Bool
logVerbose	Obtiene o establece la opción de registro detallado.	Bool
publishContentLink	Obtiene o establece el vínculo de contenido del runbook publicado.	ContentLink
runbookType	Obtiene o establece el tipo del runbook.	'Graph' 'GraphPowerShell' 'GraphPowerShellWorkflow' 'PowerShell' 'PowerShell72' 'PowerShellWorkflow' 'Python' 'Python2' 'Python3' 'Script' (obligatorio)
runtimeEnvironment	Entorno del runbook.	cuerda

RunbookDraft

Nombre	Descripción	Valor
creationTime	Obtiene o establece la hora de creación del borrador del runbook.	cuerda
draftContentLink	Obtiene o establece el vínculo de contenido del runbook borrador.	ContentLink
inEdit	Obtiene o establece si el runbook está en modo de edición.	Bool
lastModifiedTime	Obtiene o establece la hora de última modificación del borrador del runbook.	cuerda
outputTypes	Obtiene o establece los tipos de salida del runbook.	string[]
Parámetros	Obtiene o establece los parámetros de borrador del runbook.	runbookDraftParameters

RunbookDraftParameters

Nombre	Descripción	Valor

RunbookParameter

Nombre	Descripción	Valor
defaultValue	Obtiene o establece el valor predeterminado del parámetro.	cuerda
isMandatory	Obtiene o establece un valor booleano para indicar si el parámetro es obligatorio o no.	Bool
posición	Obtiene o establece la posición del parámetro.	Int
tipo	Obtiene o establece el tipo del parámetro .	cuerda

Compartir a través de

Microsoft.Automation automationAccounts/runbooks

Definición de recursos de Bicep

Formato de recurso

Valores de propiedad

ContentHash

ContentLink

Microsoft.Automation/automationAccounts/runbooks

RunbookCreateOrUpdateParametersTags

RunbookCreateOrUpdatePropertiesOrRunbookProperties

RunbookDraft

RunbookDraftParameters

RunbookParameter

Ejemplos de inicio rápido

Definición de recursos de plantilla de ARM

Formato de recurso

Valores de propiedad

ContentHash

ContentLink

Microsoft.Automation/automationAccounts/runbooks

RunbookCreateOrUpdateParametersTags

RunbookCreateOrUpdatePropertiesOrRunbookProperties

RunbookDraft

RunbookDraftParameters

RunbookParameter

Plantillas de inicio rápido

Definición de recursos de Terraform (proveedor AzAPI)

Formato de recurso

Valores de propiedad

ContentHash

ContentLink

Microsoft.Automation/automationAccounts/runbooks

RunbookCreateOrUpdateParametersTags

RunbookCreateOrUpdatePropertiesOrRunbookProperties

RunbookDraft

RunbookDraftParameters

RunbookParameter

Comentarios

Recursos adicionales