Microsoft.Automation automationAccounts/runbooks

Artikel
12/16/2024

Bicep-resursdefinition

Resurstypen automationAccounts/runbooks kan distribueras med åtgärder som mål:

Resursgrupper – Se resursgruppsdistributionskommandon

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.Automation/automationAccounts/runbooks-resurs lägger du till följande Bicep i mallen.

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

Egenskapsvärden

ContentHash

Namn	Beskrivning	Värde
algoritm	Hämtar eller anger den innehållshashalgoritm som används för att hash innehållet.	sträng (krävs)
värde	Hämtar eller anger förväntat hashvärde för innehållet.	sträng (krävs)

ContentLink

Namn	Beskrivning	Värde
contentHash	Hämtar eller anger hashen.	ContentHash
Uri	Hämtar eller anger innehållets URI.	sträng
version	Hämtar eller anger versionen av innehållet.	sträng

Microsoft.Automation/automationAccounts/runbooks

Namn	Beskrivning	Värde
plats	Hämtar eller anger platsen för resursen.	sträng
Namn	Resursnamnet	sträng Begränsningar: Mönster = `^[a-zA-Z][a-zA-Z-_0-9]*$` (krävs)
förälder	I Bicep kan du ange den överordnade resursen för en underordnad resurs. Du behöver bara lägga till den här egenskapen när den underordnade resursen deklareras utanför den överordnade resursen. Mer information finns i Underordnad resurs utanför den överordnade resursen.	Symboliskt namn för resurs av typen: automationKonton
Egenskaper	Hämtar eller anger egenskaper för att skapa eller uppdatera runbook.	RunbookCreateOrUpdatePropertiesOrRunbookProperties (krävs)
Taggar	Resurstaggar	Ordlista med taggnamn och värden. Se taggar i mallar

RunbookCreateOrUpdateParametersTags

Namn	Beskrivning	Värde

RunbookCreateOrUpdatePropertiesOrRunbookProperties

Namn	Beskrivning	Värde
beskrivning	Hämtar eller anger beskrivningen av runbooken.	sträng
utkast	Hämtar eller anger utkastskörningsegenskaperna.	RunbookDraft
logActivityTrace	Hämtar eller anger spårningsalternativen på aktivitetsnivå för runbooken.	Int
logProgress	Hämtar eller anger förloppsloggalternativ.	Bool
logVerbose	Hämtar eller anger utförligt loggalternativ.	Bool
publishContentLink	Hämtar eller anger den publicerade runbook-innehållslänken.	ContentLink
runbookType	Hämtar eller anger runbookens typ.	"Graph" "GraphPowerShell" "GraphPowerShellWorkflow" "PowerShell" "PowerShell72" "PowerShellWorkflow" "Python" "Python2" "Python3" "Skript" (krävs)
runtimeEnvironment	Miljö för runbooken.	sträng

RunbookDraft

Namn	Beskrivning	Värde
creationTime	Hämtar eller anger skapandetiden för runbook-utkastet.	sträng
draftContentLink	Hämtar eller anger innehållslänken för utkast till runbook.	ContentLink
inEdit	Hämtar eller anger om Runbook är i redigeringsläge.	Bool
lastModifiedTime	Hämtar eller anger den senaste ändrade tiden för runbook-utkastet.	sträng
outputTypes	Hämtar eller anger runbook-utdatatyperna.	string[]
Parametrar	Hämtar eller anger runbook-utkastparametrarna.	RunbookDraftParameters

RunbookDraftParameters

Namn	Beskrivning	Värde

RunbookParameter

Namn	Beskrivning	Värde
defaultValue	Hämtar eller anger standardvärdet för parametern.	sträng
isMandatory	Hämtar eller anger ett booleskt värde för att ange om parametern är obligatorisk eller inte.	Bool
position	Hämta eller anger parameterns position.	Int
typ	Hämtar eller anger parametertypen.	sträng

Snabbstartsexempel

Följande snabbstartsexempel distribuerar den här resurstypen.

Bicep-fil	Beskrivning
ASR Runbooks	Distribuerar Automation Runbooks för ASR-återställningsplaner

Resursdefinition för ARM-mall

Resurstypen automationAccounts/runbooks kan distribueras med åtgärder som mål:

Resursgrupper – Se resursgruppsdistributionskommandon

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.Automation/automationAccounts/runbooks-resurs lägger du till följande JSON i mallen.

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

Egenskapsvärden

ContentHash

Namn	Beskrivning	Värde
algoritm	Hämtar eller anger den innehållshashalgoritm som används för att hash innehållet.	sträng (krävs)
värde	Hämtar eller anger förväntat hashvärde för innehållet.	sträng (krävs)

ContentLink

Namn	Beskrivning	Värde
contentHash	Hämtar eller anger hashen.	ContentHash
Uri	Hämtar eller anger innehållets URI.	sträng
version	Hämtar eller anger versionen av innehållet.	sträng

Microsoft.Automation/automationAccounts/runbooks

Namn	Beskrivning	Värde
apiVersion	API-versionen	'2024-10-23'
plats	Hämtar eller anger platsen för resursen.	sträng
Namn	Resursnamnet	sträng Begränsningar: Mönster = `^[a-zA-Z][a-zA-Z-_0-9]*$` (krävs)
Egenskaper	Hämtar eller anger egenskaper för att skapa eller uppdatera runbook.	RunbookCreateOrUpdatePropertiesOrRunbookProperties (krävs)
Taggar	Resurstaggar	Ordlista med taggnamn och värden. Se taggar i mallar
typ	Resurstypen	"Microsoft.Automation/automationAccounts/runbooks"

RunbookCreateOrUpdateParametersTags

Namn	Beskrivning	Värde

RunbookCreateOrUpdatePropertiesOrRunbookProperties

Namn	Beskrivning	Värde
beskrivning	Hämtar eller anger beskrivningen av runbooken.	sträng
utkast	Hämtar eller anger utkastskörningsegenskaperna.	RunbookDraft
logActivityTrace	Hämtar eller anger spårningsalternativen på aktivitetsnivå för runbooken.	Int
logProgress	Hämtar eller anger förloppsloggalternativ.	Bool
logVerbose	Hämtar eller anger utförligt loggalternativ.	Bool
publishContentLink	Hämtar eller anger den publicerade runbook-innehållslänken.	ContentLink
runbookType	Hämtar eller anger runbookens typ.	"Graph" "GraphPowerShell" "GraphPowerShellWorkflow" "PowerShell" "PowerShell72" "PowerShellWorkflow" "Python" "Python2" "Python3" "Skript" (krävs)
runtimeEnvironment	Miljö för runbooken.	sträng

RunbookDraft

Namn	Beskrivning	Värde
creationTime	Hämtar eller anger skapandetiden för runbook-utkastet.	sträng
draftContentLink	Hämtar eller anger innehållslänken för utkast till runbook.	ContentLink
inEdit	Hämtar eller anger om Runbook är i redigeringsläge.	Bool
lastModifiedTime	Hämtar eller anger den senaste ändrade tiden för runbook-utkastet.	sträng
outputTypes	Hämtar eller anger runbook-utdatatyperna.	string[]
Parametrar	Hämtar eller anger runbook-utkastparametrarna.	RunbookDraftParameters

RunbookDraftParameters

Namn	Beskrivning	Värde

RunbookParameter

Namn	Beskrivning	Värde
defaultValue	Hämtar eller anger standardvärdet för parametern.	sträng
isMandatory	Hämtar eller anger ett booleskt värde för att ange om parametern är obligatorisk eller inte.	Bool
position	Hämta eller anger parameterns position.	Int
typ	Hämtar eller anger parametertypen.	sträng

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

Mall

Beskrivning

ASR Runbooks

Distribuerar Automation Runbooks för ASR-återställningsplaner

Azure Resource Optimization (ARO) Toolkit

Azure Resource Optimization Toolkit är en decentraliserad, intern Azure-lösning som använder serverlösa tekniker för att optimera Azure-resurser i din prenumeration. Optimering sker automatiskt i din prenumeration när du aktiverar eller skapar ett eget schema, inklusive på nya resurser. Det här är ett Azure Automation-konto med förkonfigurerade runbooks och scheman som du kan använda i din prenumeration för att börja spara pengar.

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen automationAccounts/runbooks kan distribueras med åtgärder som mål:

Resursgrupper

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.Automation/automationAccounts/runbooks-resurs lägger du till följande Terraform i mallen.

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

Egenskapsvärden

ContentHash

Namn	Beskrivning	Värde
algoritm	Hämtar eller anger den innehållshashalgoritm som används för att hash innehållet.	sträng (krävs)
värde	Hämtar eller anger förväntat hashvärde för innehållet.	sträng (krävs)

ContentLink

Namn	Beskrivning	Värde
contentHash	Hämtar eller anger hashen.	ContentHash
Uri	Hämtar eller anger innehållets URI.	sträng
version	Hämtar eller anger versionen av innehållet.	sträng

Microsoft.Automation/automationAccounts/runbooks

Namn	Beskrivning	Värde
plats	Hämtar eller anger platsen för resursen.	sträng
Namn	Resursnamnet	sträng Begränsningar: Mönster = `^[a-zA-Z][a-zA-Z-_0-9]*$` (krävs)
parent_id	ID för resursen som är överordnad för den här resursen.	ID för resurs av typen: automationKonton
Egenskaper	Hämtar eller anger egenskaper för att skapa eller uppdatera runbook.	RunbookCreateOrUpdatePropertiesOrRunbookProperties (krävs)
Taggar	Resurstaggar	Ordlista med taggnamn och värden.
typ	Resurstypen	"Microsoft.Automation/automationAccounts/runbooks@2024-10-23"

RunbookCreateOrUpdateParametersTags

Namn	Beskrivning	Värde

RunbookCreateOrUpdatePropertiesOrRunbookProperties

Namn	Beskrivning	Värde
beskrivning	Hämtar eller anger beskrivningen av runbooken.	sträng
utkast	Hämtar eller anger utkastskörningsegenskaperna.	RunbookDraft
logActivityTrace	Hämtar eller anger spårningsalternativen på aktivitetsnivå för runbooken.	Int
logProgress	Hämtar eller anger förloppsloggalternativ.	Bool
logVerbose	Hämtar eller anger utförligt loggalternativ.	Bool
publishContentLink	Hämtar eller anger den publicerade runbook-innehållslänken.	ContentLink
runbookType	Hämtar eller anger runbookens typ.	"Graph" "GraphPowerShell" "GraphPowerShellWorkflow" "PowerShell" "PowerShell72" "PowerShellWorkflow" "Python" "Python2" "Python3" "Skript" (krävs)
runtimeEnvironment	Miljö för runbooken.	sträng

RunbookDraft

Namn	Beskrivning	Värde
creationTime	Hämtar eller anger skapandetiden för runbook-utkastet.	sträng
draftContentLink	Hämtar eller anger innehållslänken för utkast till runbook.	ContentLink
inEdit	Hämtar eller anger om Runbook är i redigeringsläge.	Bool
lastModifiedTime	Hämtar eller anger den senaste ändrade tiden för runbook-utkastet.	sträng
outputTypes	Hämtar eller anger runbook-utdatatyperna.	string[]
Parametrar	Hämtar eller anger runbook-utkastparametrarna.	RunbookDraftParameters

RunbookDraftParameters

Namn	Beskrivning	Värde

RunbookParameter

Namn	Beskrivning	Värde
defaultValue	Hämtar eller anger standardvärdet för parametern.	sträng
isMandatory	Hämtar eller anger ett booleskt värde för att ange om parametern är obligatorisk eller inte.	Bool
position	Hämta eller anger parameterns position.	Int
typ	Hämtar eller anger parametertypen.	sträng

Dela via

Microsoft.Automation automationAccounts/runbooks

Bicep-resursdefinition

Resursformat

Egenskapsvärden

ContentHash

ContentLink

Microsoft.Automation/automationAccounts/runbooks

RunbookCreateOrUpdateParametersTags

RunbookCreateOrUpdatePropertiesOrRunbookProperties

RunbookDraft

RunbookDraftParameters

RunbookParameter

Snabbstartsexempel

Resursdefinition för ARM-mall

Resursformat

Egenskapsvärden

ContentHash

ContentLink

Microsoft.Automation/automationAccounts/runbooks

RunbookCreateOrUpdateParametersTags

RunbookCreateOrUpdatePropertiesOrRunbookProperties

RunbookDraft

RunbookDraftParameters

RunbookParameter

Snabbstartsmallar

Resursdefinition för Terraform (AzAPI-provider)

Resursformat

Egenskapsvärden

ContentHash

ContentLink

Microsoft.Automation/automationAccounts/runbooks

RunbookCreateOrUpdateParametersTags

RunbookCreateOrUpdatePropertiesOrRunbookProperties

RunbookDraft

RunbookDraftParameters

RunbookParameter

Feedback

Ytterligare resurser