Compartilhar via


Microsoft.Automation automationAccounts/runbooks 2024-10-23

Definição de recurso do Bicep

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

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

Formato de recurso

Para criar um recurso Microsoft.Automation/automationAccounts/runbooks, adicione o Bicep a seguir ao 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

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

Microsoft.Automation/automationAccounts/runbooks

Nome Descrição Valor
localização Obtém ou define o local do recurso. corda
nome O nome do recurso corda

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 do recurso do tipo: automationAccounts
Propriedades Obtém ou define propriedades de criação ou atualização de runbook. RunbookCreateOrUpdatePropertiesOrRunbookProperties (obrigatório)
Tags Marcas de recurso Dicionário de nomes e valores de marca. Consulte Marcas em modelos

RunbookCreateOrUpdateParametersTags

Nome Descrição Valor

RunbookCreateOrUpdatePropertiesOrRunbookProperties

Nome Descrição Valor
descrição Obtém ou define a descrição do runbook. corda
rascunho Obtém ou define as propriedades do runbook de rascunho. runbookDraft
logActivityTrace Obtém ou define as opções de rastreamento no nível da atividade do runbook. int
logProgress Obtém ou define a opção de log de progresso. Bool
logVerbose Obtém ou define a opção de log detalhada. Bool
publishContentLink Obtém ou define o link de conteúdo do runbook publicado. ContentLink
runbookType Obtém ou define o tipo do runbook. 'Graph'
'GraphPowerShell'
'GraphPowerShellWorkflow'
'PowerShell'
'PowerShell72'
'PowerShellWorkflow'
'Python'
'Python2'
'Python3'
'Script' (obrigatório)
runtimeEnvironment Ambiente do runbook. corda

RunbookDraft

Nome Descrição Valor
creationTime Obtém ou define a hora de criação do rascunho do runbook. corda
draftContentLink Obtém ou define o link de conteúdo do runbook de rascunho. ContentLink
inEdit 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. corda
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

Nome Descrição Valor

RunbookParameter

Nome Descrição Valor
defaultValue Obtém ou define o valor padrão do parâmetro. corda
isMandatory Obtém ou define um valor booliano para indicar se o parâmetro é obrigatório ou não. Bool
posição Obter ou definir a posição do parâmetro. int
tipo Obtém ou define o tipo do parâmetro. corda

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 do ASR Implanta runbooks de automação para planos de recuperação do ASR

Definição de recurso de modelo do ARM

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

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

Formato de recurso

Para criar um recurso Microsoft.Automation/automationAccounts/runbooks, adicione o JSON a seguir ao 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

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

Microsoft.Automation/automationAccounts/runbooks

Nome Descrição Valor
apiVersion A versão da API '2024-10-23'
localização Obtém ou define o local do recurso. corda
nome O nome do recurso corda

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

RunbookCreateOrUpdateParametersTags

Nome Descrição Valor

RunbookCreateOrUpdatePropertiesOrRunbookProperties

Nome Descrição Valor
descrição Obtém ou define a descrição do runbook. corda
rascunho Obtém ou define as propriedades do runbook de rascunho. runbookDraft
logActivityTrace Obtém ou define as opções de rastreamento no nível da atividade do runbook. int
logProgress Obtém ou define a opção de log de progresso. Bool
logVerbose Obtém ou define a opção de log detalhada. Bool
publishContentLink Obtém ou define o link de conteúdo do runbook publicado. ContentLink
runbookType Obtém ou define o tipo do runbook. 'Graph'
'GraphPowerShell'
'GraphPowerShellWorkflow'
'PowerShell'
'PowerShell72'
'PowerShellWorkflow'
'Python'
'Python2'
'Python3'
'Script' (obrigatório)
runtimeEnvironment Ambiente do runbook. corda

RunbookDraft

Nome Descrição Valor
creationTime Obtém ou define a hora de criação do rascunho do runbook. corda
draftContentLink Obtém ou define o link de conteúdo do runbook de rascunho. ContentLink
inEdit 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. corda
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

Nome Descrição Valor

RunbookParameter

Nome Descrição Valor
defaultValue Obtém ou define o valor padrão do parâmetro. corda
isMandatory Obtém ou define um valor booliano para indicar se o parâmetro é obrigatório ou não. Bool
posição Obter ou definir a posição do parâmetro. int
tipo Obtém ou define o tipo do parâmetro. corda

Modelos de início rápido

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

Modelo Descrição
runbooks do ASR

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

Implantar no Azure
O Kit de Ferramentas de Otimização de Recursos do Azure é uma solução descentralizada e nativa do Azure usando tecnologias sem servidor para otimizar os recursos do Azure em sua assinatura. A otimização ocorre automaticamente em sua assinatura depois que você habilita ou cria sua própria agenda, inclusive em novos recursos. Essa é uma conta de Automação do Azure com runbooks pré-configurados e agendamentos que você pode utilizar em sua assinatura para começar a economizar dinheiro.

Definição de recurso do Terraform (provedor de AzAPI)

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

  • grupos de recursos

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

Formato de recurso

Para criar um recurso Microsoft.Automation/automationAccounts/runbooks, adicione o Terraform a seguir 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

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

Microsoft.Automation/automationAccounts/runbooks

Nome Descrição Valor
localização Obtém ou define o local do recurso. corda
nome O nome do recurso corda

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

RunbookCreateOrUpdateParametersTags

Nome Descrição Valor

RunbookCreateOrUpdatePropertiesOrRunbookProperties

Nome Descrição Valor
descrição Obtém ou define a descrição do runbook. corda
rascunho Obtém ou define as propriedades do runbook de rascunho. runbookDraft
logActivityTrace Obtém ou define as opções de rastreamento no nível da atividade do runbook. int
logProgress Obtém ou define a opção de log de progresso. Bool
logVerbose Obtém ou define a opção de log detalhada. Bool
publishContentLink Obtém ou define o link de conteúdo do runbook publicado. ContentLink
runbookType Obtém ou define o tipo do runbook. 'Graph'
'GraphPowerShell'
'GraphPowerShellWorkflow'
'PowerShell'
'PowerShell72'
'PowerShellWorkflow'
'Python'
'Python2'
'Python3'
'Script' (obrigatório)
runtimeEnvironment Ambiente do runbook. corda

RunbookDraft

Nome Descrição Valor
creationTime Obtém ou define a hora de criação do rascunho do runbook. corda
draftContentLink Obtém ou define o link de conteúdo do runbook de rascunho. ContentLink
inEdit 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. corda
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

Nome Descrição Valor

RunbookParameter

Nome Descrição Valor
defaultValue Obtém ou define o valor padrão do parâmetro. corda
isMandatory Obtém ou define um valor booliano para indicar se o parâmetro é obrigatório ou não. Bool
posição Obter ou definir a posição do parâmetro. int
tipo Obtém ou define o tipo do parâmetro. corda