Microsoft.Automation automationAccounts/runbook

Articolo
12/16/2024

Definizione di risorsa Bicep

Il tipo di risorsa automationAccounts/runbook può essere distribuito con operazioni destinate a:

gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.Automation/automationAccounts/runbook, aggiungere il bicep seguente al modello.

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'
  }
}

Valori delle proprietà

ContentHash

Nome	Descrizione	Valore
algoritmo	Ottiene o imposta l'algoritmo hash del contenuto utilizzato per eseguire l'hashing del contenuto.	stringa (obbligatorio)
valore	Ottiene o imposta il valore hash previsto del contenuto.	stringa (obbligatorio)

ContentLink

Nome	Descrizione	Valore
contentHash	Ottiene o imposta l'hash.	ContentHash
Uri	Ottiene o imposta l'URI del contenuto.	corda
Versione	Ottiene o imposta la versione del contenuto.	corda

Microsoft.Automation/automationAccounts/runbook

Nome	Descrizione	Valore
ubicazione	Ottiene o imposta la posizione della risorsa.	corda
nome	Nome della risorsa	corda Vincoli: Pattern = `^[a-zA-Z][a-zA-Z-_0-9]*$` (obbligatorio)
genitore	In Bicep è possibile specificare la risorsa padre per una risorsa figlio. È necessario aggiungere questa proprietà solo quando la risorsa figlio viene dichiarata all'esterno della risorsa padre. Per altre informazioni, vedere risorsa figlio all'esterno della risorsa padre.	Nome simbolico per la risorsa di tipo: automationAccounts
proprietà	Ottiene o imposta le proprietà di creazione o aggiornamento del runbook.	RunbookCreateOrUpdatePropertiesOrRunbookProperties (obbligatorio)
Tag	Tag delle risorse	Dizionario di nomi e valori di tag. Vedere tag nei modelli

RunbookCreateOrUpdateParametersTags

Nome	Descrizione	Valore

RunbookCreateOrUpdatePropertiesOrRunbookProperties

Nome	Descrizione	Valore
descrizione	Ottiene o imposta la descrizione del runbook.	corda
Bozza	Ottiene o imposta le proprietà del runbook bozza.	RunbookDraft
logActivityTrace	Ottiene o imposta le opzioni di traccia a livello di attività del runbook.	Int
logProgress	Ottiene o imposta l'opzione del log di stato.	Bool
logVerbose	Ottiene o imposta l'opzione di log dettagliata.	Bool
publishContentLink	Ottiene o imposta il collegamento al contenuto del runbook pubblicato.	ContentLink
runbookType	Ottiene o imposta il tipo del runbook.	'Graph' 'GraphPowerShell' 'GraphPowerShellWorkflow' 'PowerShell' 'PowerShell72' 'PowerShellWorkflow' 'Python' 'Python2' 'Python3' 'Script' (obbligatorio)
runtimeEnvironment	Ambiente del runbook.	corda

RunbookDraft

Nome	Descrizione	Valore
creationTime	Ottiene o imposta l'ora di creazione della bozza del runbook.	corda
draftContentLink	Ottiene o imposta il collegamento al contenuto del runbook bozza.	ContentLink
inEdit	Ottiene o imposta un valore che indica se il runbook è in modalità di modifica.	Bool
lastModifiedTime	Ottiene o imposta l'ora dell'ultima modifica della bozza del runbook.	corda
outputTypes	Ottiene o imposta i tipi di output del runbook.	string[]
Parametri	Ottiene o imposta i parametri della bozza del runbook.	RunbookDraftParameters

RunbookDraftParameters

Nome	Descrizione	Valore

RunbookParameter

Nome	Descrizione	Valore
defaultValue	Ottiene o imposta il valore predefinito del parametro.	corda
isMandatory	Ottiene o imposta un valore booleano per indicare se il parametro è obbligatorio o meno.	Bool
posizione	Ottiene o imposta la posizione del parametro.	Int
digitare	Ottiene o imposta il tipo del parametro.	corda

Esempi di utilizzo

Esempi di avvio rapido di Azure

I modelli di avvio rapido di Azure seguenti contengono esempi Bicep per la distribuzione di questo tipo di risorsa.

Bicep File	Descrizione
runbook asr	Distribuisce runbook di automazione per i piani di ripristino asr

Definizione di risorsa del modello di Resource Manager

Il tipo di risorsa automationAccounts/runbook può essere distribuito con operazioni destinate a:

gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.Automation/automationAccounts/runbook, aggiungere il codice JSON seguente al modello.

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

Valori delle proprietà

ContentHash

Nome	Descrizione	Valore
algoritmo	Ottiene o imposta l'algoritmo hash del contenuto utilizzato per eseguire l'hashing del contenuto.	stringa (obbligatorio)
valore	Ottiene o imposta il valore hash previsto del contenuto.	stringa (obbligatorio)

ContentLink

Nome	Descrizione	Valore
contentHash	Ottiene o imposta l'hash.	ContentHash
Uri	Ottiene o imposta l'URI del contenuto.	corda
Versione	Ottiene o imposta la versione del contenuto.	corda

Microsoft.Automation/automationAccounts/runbook

Nome	Descrizione	Valore
apiVersion	Versione dell'API	'2024-10-23'
ubicazione	Ottiene o imposta la posizione della risorsa.	corda
nome	Nome della risorsa	corda Vincoli: Pattern = `^[a-zA-Z][a-zA-Z-_0-9]*$` (obbligatorio)
proprietà	Ottiene o imposta le proprietà di creazione o aggiornamento del runbook.	RunbookCreateOrUpdatePropertiesOrRunbookProperties (obbligatorio)
Tag	Tag delle risorse	Dizionario di nomi e valori di tag. Vedere tag nei modelli
digitare	Tipo di risorsa	'Microsoft.Automation/automationAccounts/runbook'

RunbookCreateOrUpdateParametersTags

Nome	Descrizione	Valore

RunbookCreateOrUpdatePropertiesOrRunbookProperties

Nome	Descrizione	Valore
descrizione	Ottiene o imposta la descrizione del runbook.	corda
Bozza	Ottiene o imposta le proprietà del runbook bozza.	RunbookDraft
logActivityTrace	Ottiene o imposta le opzioni di traccia a livello di attività del runbook.	Int
logProgress	Ottiene o imposta l'opzione del log di stato.	Bool
logVerbose	Ottiene o imposta l'opzione di log dettagliata.	Bool
publishContentLink	Ottiene o imposta il collegamento al contenuto del runbook pubblicato.	ContentLink
runbookType	Ottiene o imposta il tipo del runbook.	'Graph' 'GraphPowerShell' 'GraphPowerShellWorkflow' 'PowerShell' 'PowerShell72' 'PowerShellWorkflow' 'Python' 'Python2' 'Python3' 'Script' (obbligatorio)
runtimeEnvironment	Ambiente del runbook.	corda

RunbookDraft

Nome	Descrizione	Valore
creationTime	Ottiene o imposta l'ora di creazione della bozza del runbook.	corda
draftContentLink	Ottiene o imposta il collegamento al contenuto del runbook bozza.	ContentLink
inEdit	Ottiene o imposta un valore che indica se il runbook è in modalità di modifica.	Bool
lastModifiedTime	Ottiene o imposta l'ora dell'ultima modifica della bozza del runbook.	corda
outputTypes	Ottiene o imposta i tipi di output del runbook.	string[]
Parametri	Ottiene o imposta i parametri della bozza del runbook.	RunbookDraftParameters

RunbookDraftParameters

Nome	Descrizione	Valore

RunbookParameter

Nome	Descrizione	Valore
defaultValue	Ottiene o imposta il valore predefinito del parametro.	corda
isMandatory	Ottiene o imposta un valore booleano per indicare se il parametro è obbligatorio o meno.	Bool
posizione	Ottiene o imposta la posizione del parametro.	Int
digitare	Ottiene o imposta il tipo del parametro.	corda

Esempi di utilizzo

Modelli di avvio rapido di Azure

I modelli di avvio rapido di Azure seguenti distribuire questo tipo di risorsa.

Sagoma

Descrizione

runbook asr

Distribuisce runbook di automazione per i piani di ripristino asr

Azure Resource Optimization (ARO) Toolkit

Azure Resource Optimization Toolkit è una soluzione azure decentralizzata e nativa che usa tecnologie serverless per ottimizzare le risorse di Azure nella sottoscrizione. L'ottimizzazione viene eseguita automaticamente nella sottoscrizione dopo aver abilitato o creato una pianificazione personalizzata, incluse le nuove risorse. Si tratta di un account di Automazione di Azure con runbook preconfigurati e pianificazioni che è possibile usare nella sottoscrizione per iniziare a risparmiare denaro.

Definizione di risorsa Terraform (provider AzAPI)

Il tipo di risorsa automationAccounts/runbook può essere distribuito con operazioni destinate a:

gruppi di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.Automation/automationAccounts/runbook, aggiungere il seguente Terraform al modello.

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"
    }
  })
}

Valori delle proprietà

ContentHash

Nome	Descrizione	Valore
algoritmo	Ottiene o imposta l'algoritmo hash del contenuto utilizzato per eseguire l'hashing del contenuto.	stringa (obbligatorio)
valore	Ottiene o imposta il valore hash previsto del contenuto.	stringa (obbligatorio)

ContentLink

Nome	Descrizione	Valore
contentHash	Ottiene o imposta l'hash.	ContentHash
Uri	Ottiene o imposta l'URI del contenuto.	corda
Versione	Ottiene o imposta la versione del contenuto.	corda

Microsoft.Automation/automationAccounts/runbook

Nome	Descrizione	Valore
ubicazione	Ottiene o imposta la posizione della risorsa.	corda
nome	Nome della risorsa	corda Vincoli: Pattern = `^[a-zA-Z][a-zA-Z-_0-9]*$` (obbligatorio)
parent_id	ID della risorsa padre per questa risorsa.	ID per la risorsa di tipo: automationAccounts
proprietà	Ottiene o imposta le proprietà di creazione o aggiornamento del runbook.	RunbookCreateOrUpdatePropertiesOrRunbookProperties (obbligatorio)
Tag	Tag delle risorse	Dizionario di nomi e valori di tag.
digitare	Tipo di risorsa	"Microsoft.Automation/automationAccounts/runbooks@2024-10-23"

RunbookCreateOrUpdateParametersTags

Nome	Descrizione	Valore

RunbookCreateOrUpdatePropertiesOrRunbookProperties

Nome	Descrizione	Valore
descrizione	Ottiene o imposta la descrizione del runbook.	corda
Bozza	Ottiene o imposta le proprietà del runbook bozza.	RunbookDraft
logActivityTrace	Ottiene o imposta le opzioni di traccia a livello di attività del runbook.	Int
logProgress	Ottiene o imposta l'opzione del log di stato.	Bool
logVerbose	Ottiene o imposta l'opzione di log dettagliata.	Bool
publishContentLink	Ottiene o imposta il collegamento al contenuto del runbook pubblicato.	ContentLink
runbookType	Ottiene o imposta il tipo del runbook.	'Graph' 'GraphPowerShell' 'GraphPowerShellWorkflow' 'PowerShell' 'PowerShell72' 'PowerShellWorkflow' 'Python' 'Python2' 'Python3' 'Script' (obbligatorio)
runtimeEnvironment	Ambiente del runbook.	corda

RunbookDraft

Nome	Descrizione	Valore
creationTime	Ottiene o imposta l'ora di creazione della bozza del runbook.	corda
draftContentLink	Ottiene o imposta il collegamento al contenuto del runbook bozza.	ContentLink
inEdit	Ottiene o imposta un valore che indica se il runbook è in modalità di modifica.	Bool
lastModifiedTime	Ottiene o imposta l'ora dell'ultima modifica della bozza del runbook.	corda
outputTypes	Ottiene o imposta i tipi di output del runbook.	string[]
Parametri	Ottiene o imposta i parametri della bozza del runbook.	RunbookDraftParameters

RunbookDraftParameters

Nome	Descrizione	Valore

RunbookParameter

Nome	Descrizione	Valore
defaultValue	Ottiene o imposta il valore predefinito del parametro.	corda
isMandatory	Ottiene o imposta un valore booleano per indicare se il parametro è obbligatorio o meno.	Bool
posizione	Ottiene o imposta la posizione del parametro.	Int
digitare	Ottiene o imposta il tipo del parametro.	corda

Condividi tramite

Microsoft.Automation automationAccounts/runbook

Definizione di risorsa Bicep

Formato risorsa

Valori delle proprietà

ContentHash

ContentLink

Microsoft.Automation/automationAccounts/runbook

RunbookCreateOrUpdateParametersTags

RunbookCreateOrUpdatePropertiesOrRunbookProperties

RunbookDraft

RunbookDraftParameters

RunbookParameter

Esempi di utilizzo

Esempi di avvio rapido di Azure

Definizione di risorsa del modello di Resource Manager

Formato risorsa

Valori delle proprietà

ContentHash

ContentLink

Microsoft.Automation/automationAccounts/runbook

RunbookCreateOrUpdateParametersTags

RunbookCreateOrUpdatePropertiesOrRunbookProperties

RunbookDraft

RunbookDraftParameters

RunbookParameter

Esempi di utilizzo

Modelli di avvio rapido di Azure

Definizione di risorsa Terraform (provider AzAPI)

Formato risorsa

Valori delle proprietà

ContentHash

ContentLink

Microsoft.Automation/automationAccounts/runbook

RunbookCreateOrUpdateParametersTags

RunbookCreateOrUpdatePropertiesOrRunbookProperties

RunbookDraft

RunbookDraftParameters

RunbookParameter

Commenti e suggerimenti

Risorse aggiuntive