Partilhar via


Microsoft.Automation automationContas/runbooks

Definição de recursos do bíceps

O tipo de recurso automationAccounts/runbooks pode ser implantado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.Automation/automationAccounts/runbooks, adicione o seguinte Bicep ao seu modelo.

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 propriedade

ContentHash

Designação Descrição Valor
algoritmo Obtém ou define o algoritmo de hash de conteúdo usado para hash do conteúdo. string (obrigatório)
valor Obtém ou define o valor de hash esperado do conteúdo. string (obrigatório)
Designação Descrição Valor
contentHash Obtém ou define o hash. ContentHash
URI Obtém ou define o uri do conteúdo. string
Versão Obtém ou define a versão do conteúdo. string

Microsoft.Automation/automationAccounts/runbooks

Designação Descrição Valor
Localização Obtém ou define o local do recurso. string
Designação O nome do recurso string

Restrições:
Padrão = ^[a-zA-Z][a-zA-Z-_0-9]*$ (obrigatório)
pai No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai.

Para obter mais informações, consulte recurso filho fora do recurso pai.
Nome simbólico para recurso do tipo: automationAccounts
propriedades Obtém ou define runbook, criar ou atualizar propriedades. RunbookCreateOrUpdatePropertiesOrRunbookProperties (obrigatório)
Etiquetas Tags de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos

RunbookCreateOrUpdateParametersTags

Designação Descrição Valor

RunbookCreateOrUpdatePropertiesOrRunbookProperties

Designação Descrição Valor
Descrição Obtém ou define a descrição do runbook. string
rascunho Obtém ou define as propriedades do runbook de rascunho. RunbookDraft
logActivityTrace Obtém ou define as opções de rastreamento de nível de atividade do runbook. Int
logProgresso Obtém ou define a opção de log de progresso. Bool
logVerbose Obtém ou define a opção de log detalhado. Bool
publicarContentLink Obtém ou define o link de conteúdo do runbook publicado. ContentLink
runbookType Obtém ou define o tipo do runbook. 'Gráfico'
'GraphPowerShell'
'GraphPowerShellWorkflow'
'PowerShell'
'PowerShell72'
'PowerShellWorkflow'
'Python'
'Python2'
'Python3'
'Script' (obrigatório)
runtimeAmbiente: Ambiente do runbook. string

RunbookDraft

Designação Descrição Valor
criaçãoTempo de criação Obtém ou define o tempo de criação do rascunho do runbook. string
rascunhoContentLink Obtém ou define o link de conteúdo do runbook de rascunho. ContentLink
emEditar Obtém ou define se o runbook está no modo de edição. Bool
lastModifiedTime Obtém ou define a hora da última modificação do rascunho do runbook. string
outputTypes Obtém ou define os tipos de saída do runbook. string[]
Parâmetros Obtém ou define os parâmetros de rascunho do runbook. RunbookDraftParameters

RunbookDraftParameters

Designação Descrição Valor

RunbookParameter

Designação Descrição Valor
defaultValue Obtém ou define o valor padrão do parâmetro. string
isObrigatório Obtém ou define um valor booleano para indicar se o parâmetro é obrigatório ou não. Bool
posição Obter ou define a posição do parâmetro. Int
tipo Obtém ou define o tipo do parâmetro. string

Exemplos de início rápido

Os exemplos de início rápido a seguir implantam esse tipo de recurso.

Arquivo Bicep Descrição
Runbooks ASR Implanta runbooks de automação para planos de recuperação ASR

Definição de recurso de modelo ARM

O tipo de recurso automationAccounts/runbooks pode ser implantado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.Automation/automationAccounts/runbooks, adicione o seguinte JSON ao seu modelo.

{
  "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 propriedade

ContentHash

Designação Descrição Valor
algoritmo Obtém ou define o algoritmo de hash de conteúdo usado para hash do conteúdo. string (obrigatório)
valor Obtém ou define o valor de hash esperado do conteúdo. string (obrigatório)
Designação Descrição Valor
contentHash Obtém ou define o hash. ContentHash
URI Obtém ou define o uri do conteúdo. string
Versão Obtém ou define a versão do conteúdo. string

Microsoft.Automation/automationAccounts/runbooks

Designação Descrição Valor
apiVersion A versão api '2024-10-23'
Localização Obtém ou define o local do recurso. string
Designação O nome do recurso string

Restrições:
Padrão = ^[a-zA-Z][a-zA-Z-_0-9]*$ (obrigatório)
propriedades Obtém ou define runbook, criar ou atualizar propriedades. RunbookCreateOrUpdatePropertiesOrRunbookProperties (obrigatório)
Etiquetas Tags de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos
tipo O tipo de recurso 'Microsoft.Automation/automationAccounts/runbooks'

RunbookCreateOrUpdateParametersTags

Designação Descrição Valor

RunbookCreateOrUpdatePropertiesOrRunbookProperties

Designação Descrição Valor
Descrição Obtém ou define a descrição do runbook. string
rascunho Obtém ou define as propriedades do runbook de rascunho. RunbookDraft
logActivityTrace Obtém ou define as opções de rastreamento de nível de atividade do runbook. Int
logProgresso Obtém ou define a opção de log de progresso. Bool
logVerbose Obtém ou define a opção de log detalhado. Bool
publicarContentLink Obtém ou define o link de conteúdo do runbook publicado. ContentLink
runbookType Obtém ou define o tipo do runbook. 'Gráfico'
'GraphPowerShell'
'GraphPowerShellWorkflow'
'PowerShell'
'PowerShell72'
'PowerShellWorkflow'
'Python'
'Python2'
'Python3'
'Script' (obrigatório)
runtimeAmbiente: Ambiente do runbook. string

RunbookDraft

Designação Descrição Valor
criaçãoTempo de criação Obtém ou define o tempo de criação do rascunho do runbook. string
rascunhoContentLink Obtém ou define o link de conteúdo do runbook de rascunho. ContentLink
emEditar Obtém ou define se o runbook está no modo de edição. Bool
lastModifiedTime Obtém ou define a hora da última modificação do rascunho do runbook. string
outputTypes Obtém ou define os tipos de saída do runbook. string[]
Parâmetros Obtém ou define os parâmetros de rascunho do runbook. RunbookDraftParameters

RunbookDraftParameters

Designação Descrição Valor

RunbookParameter

Designação Descrição Valor
defaultValue Obtém ou define o valor padrão do parâmetro. string
isObrigatório Obtém ou define um valor booleano para indicar se o parâmetro é obrigatório ou não. Bool
posição Obter ou define a posição do parâmetro. Int
tipo Obtém ou define o tipo do parâmetro. string

Modelos de início rápido

Os modelos de início rápido a seguir implantam esse tipo de recurso.

Modelo Descrição
Runbooks ASR

Implantar no Azure
Implanta runbooks de automação para planos de recuperação ASR
do Kit de Ferramentas de Otimização de Recursos do Azure (ARO)

Implantar no Azure
O Kit de Ferramentas de Otimização de Recursos do Azure é uma solução descentralizada e nativa do Azure que usa tecnologias sem servidor para otimizar os recursos do Azure em sua assinatura. A otimização acontece automaticamente na sua subscrição assim que ativar ou criar a sua própria agenda, incluindo novos recursos. Esta é uma conta de Automação do Azure com runbooks e agendas pré-configurados que você pode utilizar em sua assinatura para começar a economizar dinheiro.

Definição de recursos Terraform (provedor AzAPI)

O tipo de recurso automationAccounts/runbooks pode ser implantado com operações que visam:

  • Grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.Automation/automationAccounts/runbooks, adicione o seguinte Terraform ao seu modelo.

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 propriedade

ContentHash

Designação Descrição Valor
algoritmo Obtém ou define o algoritmo de hash de conteúdo usado para hash do conteúdo. string (obrigatório)
valor Obtém ou define o valor de hash esperado do conteúdo. string (obrigatório)
Designação Descrição Valor
contentHash Obtém ou define o hash. ContentHash
URI Obtém ou define o uri do conteúdo. string
Versão Obtém ou define a versão do conteúdo. string

Microsoft.Automation/automationAccounts/runbooks

Designação Descrição Valor
Localização Obtém ou define o local do recurso. string
Designação O nome do recurso string

Restrições:
Padrão = ^[a-zA-Z][a-zA-Z-_0-9]*$ (obrigatório)
parent_id A ID do recurso que é o pai para este recurso. ID do recurso do tipo: automationAccounts
propriedades Obtém ou define runbook, criar ou atualizar propriedades. RunbookCreateOrUpdatePropertiesOrRunbookProperties (obrigatório)
Etiquetas Tags de recursos Dicionário de nomes e valores de tags.
tipo O tipo de recurso "Microsoft.Automation/automationAccounts/runbooks@2024-10-23"

RunbookCreateOrUpdateParametersTags

Designação Descrição Valor

RunbookCreateOrUpdatePropertiesOrRunbookProperties

Designação Descrição Valor
Descrição Obtém ou define a descrição do runbook. string
rascunho Obtém ou define as propriedades do runbook de rascunho. RunbookDraft
logActivityTrace Obtém ou define as opções de rastreamento de nível de atividade do runbook. Int
logProgresso Obtém ou define a opção de log de progresso. Bool
logVerbose Obtém ou define a opção de log detalhado. Bool
publicarContentLink Obtém ou define o link de conteúdo do runbook publicado. ContentLink
runbookType Obtém ou define o tipo do runbook. 'Gráfico'
'GraphPowerShell'
'GraphPowerShellWorkflow'
'PowerShell'
'PowerShell72'
'PowerShellWorkflow'
'Python'
'Python2'
'Python3'
'Script' (obrigatório)
runtimeAmbiente: Ambiente do runbook. string

RunbookDraft

Designação Descrição Valor
criaçãoTempo de criação Obtém ou define o tempo de criação do rascunho do runbook. string
rascunhoContentLink Obtém ou define o link de conteúdo do runbook de rascunho. ContentLink
emEditar Obtém ou define se o runbook está no modo de edição. Bool
lastModifiedTime Obtém ou define a hora da última modificação do rascunho do runbook. string
outputTypes Obtém ou define os tipos de saída do runbook. string[]
Parâmetros Obtém ou define os parâmetros de rascunho do runbook. RunbookDraftParameters

RunbookDraftParameters

Designação Descrição Valor

RunbookParameter

Designação Descrição Valor
defaultValue Obtém ou define o valor padrão do parâmetro. string
isObrigatório Obtém ou define um valor booleano para indicar se o parâmetro é obrigatório ou não. Bool
posição Obter ou define a posição do parâmetro. Int
tipo Obtém ou define o tipo do parâmetro. string