Microsoft.Automation automationAccounts/runbooks 2022-08-08

Artikel
16.12.2024

Bicep-Ressourcendefinition

Der Ressourcentyp "automationAccounts/runbooks" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Ressourcengruppen – Siehe Ressourcengruppenbereitstellungsbefehle

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.Automation/automationAccounts/runbooks-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Bicep hinzu.

resource symbolicname 'Microsoft.Automation/automationAccounts/runbooks@2022-08-08' = {
  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'
  }
  tags: {
    {customized property}: 'string'
  }
}

Eigenschaftswerte

ContentHash

Name	Beschreibung	Wert
Algorithmus	Ruft den Inhaltshashalgorithmus ab, der zum Hashen des Inhalts verwendet wird, oder legt diesen fest.	Zeichenfolge (erforderlich)
Wert	Dient zum Abrufen oder Festlegen des erwarteten Hashwerts des Inhalts.	Zeichenfolge (erforderlich)

ContentLink

Name	Beschreibung	Wert
contentHash	Ruft den Hash ab oder legt den Hash fest.	ContentHash-
Uri	Dient zum Abrufen oder Festlegen des URI des Runbook-Inhalts.	Schnur
Version	Ruft die Version des Inhalts ab oder legt sie fest.	Schnur

Microsoft.Automation/automationAccounts/runbooks

Name	Beschreibung	Wert
Ort	Dient zum Abrufen oder Festlegen des Speicherorts der Ressource.	Schnur
Name	Der Ressourcenname	Schnur Zwänge: Pattern = `^[a-zA-Z][a-zA-Z-_0-9]*$` (erforderlich)
Elternteil	In Bicep können Sie die übergeordnete Ressource für eine untergeordnete Ressource angeben. Sie müssen diese Eigenschaft nur hinzufügen, wenn die untergeordnete Ressource außerhalb der übergeordneten Ressource deklariert wird. Weitere Informationen finden Sie unter Untergeordnete Ressource außerhalb der übergeordneten Ressource.	Symbolischer Name für Ressource des Typs: automationAccounts
Eigenschaften	Dient zum Abrufen oder Festlegen von Runbook-Erstellungs- oder Aktualisierungseigenschaften.	RunbookCreateOrUpdatePropertiesOrRunbookProperties (erforderlich)
Schilder	Ressourcentags	Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen

RunbookCreateOrUpdateParametersTags

Name	Beschreibung	Wert

RunbookCreateOrUpdatePropertiesOrRunbookProperties

Name	Beschreibung	Wert
Beschreibung	Ruft die Beschreibung des Runbook ab oder legt diese fest.	Schnur
Entwurf	Dient zum Abrufen oder Festlegen der Entwurfs-Runbook-Eigenschaften.	RunbookDraft-
logActivityTrace	Dient zum Abrufen oder Festlegen der Optionen für die Ablaufverfolgung auf Aktivitätsebene des Runbook.	Int
logProgress	Ruft die Statusprotokolloption ab oder legt sie fest.	Bool
logVerbose	Ruft die ausführliche Protokolloption ab oder legt sie fest.	Bool
publishContentLink	Dient zum Abrufen oder Festlegen des veröffentlichten Runbook-Inhaltslinks.	ContentLink-
runbookType	Dient zum Abrufen oder Festlegen des Typs des Runbook.	'Graph' "GraphPowerShell" 'GraphPowerShellWorkflow' "PowerShell" "PowerShellWorkflow" "Python2" "Python3" 'Skript' (erforderlich)

RunbookDraft

Name	Beschreibung	Wert
creationTime	Ruft die Erstellungszeit des Runbook-Entwurfs ab oder legt sie fest.	Schnur
draftContentLink	Dient zum Abrufen oder Festlegen des Entwurfs eines Runbook-Inhaltslinks.	ContentLink-
inEdit	Ruft ab oder legt fest, ob sich runbook im Bearbeitungsmodus befindet.	Bool
lastModifiedTime	Ruft die uhrzeit der letzten Änderung des Runbook-Entwurfs ab oder legt sie fest.	Schnur
outputTypes	Dient zum Abrufen oder Festlegen der Runbook-Ausgabetypen.	string[]
Parameter	Ruft die Entwurfsparameter des Runbook ab oder legt diese fest.	RunbookDraftParameters

RunbookDraftParameters

Name	Beschreibung	Wert

RunbookParameter

Name	Beschreibung	Wert
defaultValue	Dient zum Abrufen oder Festlegen des Standardwerts des Parameters.	Schnur
isMandatory	Dient zum Abrufen oder Festlegen eines booleschen Werts, der angibt, ob der Parameter obligatorisch ist oder nicht.	Bool
Position	Dient zum Abrufen oder Festlegen der Position des Parameters.	Int
Art	Dient zum Abrufen oder Festlegen des Typs des Parameters.	Schnur

Verwendungsbeispiele

Azure-Schnellstartbeispiele

Die folgenden Azure-Schnellstartvorlagen Bicep-Beispiele für die Bereitstellung dieses Ressourcentyps enthalten.

Bicep-Datei	Beschreibung
ASR Runbooks	Stellt Automatisierungsrunbooks für ASR-Wiederherstellungspläne bereit

ARM-Vorlagenressourcendefinition

Der Ressourcentyp "automationAccounts/runbooks" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Ressourcengruppen – Siehe Ressourcengruppenbereitstellungsbefehle

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.Automation/automationAccounts/runbooks-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.

{
  "type": "Microsoft.Automation/automationAccounts/runbooks",
  "apiVersion": "2022-08-08",
  "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"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Eigenschaftswerte

ContentHash

Name	Beschreibung	Wert
Algorithmus	Ruft den Inhaltshashalgorithmus ab, der zum Hashen des Inhalts verwendet wird, oder legt diesen fest.	Zeichenfolge (erforderlich)
Wert	Dient zum Abrufen oder Festlegen des erwarteten Hashwerts des Inhalts.	Zeichenfolge (erforderlich)

ContentLink

Name	Beschreibung	Wert
contentHash	Ruft den Hash ab oder legt den Hash fest.	ContentHash-
Uri	Dient zum Abrufen oder Festlegen des URI des Runbook-Inhalts.	Schnur
Version	Ruft die Version des Inhalts ab oder legt sie fest.	Schnur

Microsoft.Automation/automationAccounts/runbooks

Name	Beschreibung	Wert
apiVersion	Die API-Version	'2022-08-08'
Ort	Dient zum Abrufen oder Festlegen des Speicherorts der Ressource.	Schnur
Name	Der Ressourcenname	Schnur Zwänge: Pattern = `^[a-zA-Z][a-zA-Z-_0-9]*$` (erforderlich)
Eigenschaften	Dient zum Abrufen oder Festlegen von Runbook-Erstellungs- oder Aktualisierungseigenschaften.	RunbookCreateOrUpdatePropertiesOrRunbookProperties (erforderlich)
Schilder	Ressourcentags	Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
Art	Der Ressourcentyp	"Microsoft.Automation/automationAccounts/runbooks"

RunbookCreateOrUpdateParametersTags

Name	Beschreibung	Wert

RunbookCreateOrUpdatePropertiesOrRunbookProperties

Name	Beschreibung	Wert
Beschreibung	Ruft die Beschreibung des Runbook ab oder legt diese fest.	Schnur
Entwurf	Dient zum Abrufen oder Festlegen der Entwurfs-Runbook-Eigenschaften.	RunbookDraft-
logActivityTrace	Dient zum Abrufen oder Festlegen der Optionen für die Ablaufverfolgung auf Aktivitätsebene des Runbook.	Int
logProgress	Ruft die Statusprotokolloption ab oder legt sie fest.	Bool
logVerbose	Ruft die ausführliche Protokolloption ab oder legt sie fest.	Bool
publishContentLink	Dient zum Abrufen oder Festlegen des veröffentlichten Runbook-Inhaltslinks.	ContentLink-
runbookType	Dient zum Abrufen oder Festlegen des Typs des Runbook.	'Graph' "GraphPowerShell" 'GraphPowerShellWorkflow' "PowerShell" "PowerShellWorkflow" "Python2" "Python3" 'Skript' (erforderlich)

RunbookDraft

Name	Beschreibung	Wert
creationTime	Ruft die Erstellungszeit des Runbook-Entwurfs ab oder legt sie fest.	Schnur
draftContentLink	Dient zum Abrufen oder Festlegen des Entwurfs eines Runbook-Inhaltslinks.	ContentLink-
inEdit	Ruft ab oder legt fest, ob sich runbook im Bearbeitungsmodus befindet.	Bool
lastModifiedTime	Ruft die uhrzeit der letzten Änderung des Runbook-Entwurfs ab oder legt sie fest.	Schnur
outputTypes	Dient zum Abrufen oder Festlegen der Runbook-Ausgabetypen.	string[]
Parameter	Ruft die Entwurfsparameter des Runbook ab oder legt diese fest.	RunbookDraftParameters

RunbookDraftParameters

Name	Beschreibung	Wert

RunbookParameter

Name	Beschreibung	Wert
defaultValue	Dient zum Abrufen oder Festlegen des Standardwerts des Parameters.	Schnur
isMandatory	Dient zum Abrufen oder Festlegen eines booleschen Werts, der angibt, ob der Parameter obligatorisch ist oder nicht.	Bool
Position	Dient zum Abrufen oder Festlegen der Position des Parameters.	Int
Art	Dient zum Abrufen oder Festlegen des Typs des Parameters.	Schnur

Verwendungsbeispiele

Azure-Schnellstartvorlagen

Die folgenden Azure-Schnellstartvorlagen diesen Ressourcentyp bereitstellen.

Schablone

Beschreibung

ASR Runbooks

Stellt Automatisierungsrunbooks für ASR-Wiederherstellungspläne bereit

Azure Resource Optimization (ARO)-Toolkit-

Das Azure Resource Optimization Toolkit ist eine dezentrale, systemeigene Azure-Lösung, die serverlose Technologien verwendet, um Azure-Ressourcen in Ihrem Abonnement zu optimieren. Die Optimierung erfolgt automatisch in Ihrem Abonnement, nachdem Sie Ihren eigenen Zeitplan aktiviert oder erstellt haben, einschließlich neuer Ressourcen. Dies ist ein Azure Automation-Konto mit vorkonfigurierten Runbooks und Zeitplänen, die Sie für Ihr Abonnement nutzen können, um mit dem Sparen von Geld zu beginnen.

Terraform -Ressourcendefinition (AzAPI-Anbieter)

Der Ressourcentyp "automationAccounts/runbooks" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Ressourcengruppen

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.Automation/automationAccounts/runbooks-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Automation/automationAccounts/runbooks@2022-08-08"
  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"
    }
  })
}

Eigenschaftswerte

ContentHash

Name	Beschreibung	Wert
Algorithmus	Ruft den Inhaltshashalgorithmus ab, der zum Hashen des Inhalts verwendet wird, oder legt diesen fest.	Zeichenfolge (erforderlich)
Wert	Dient zum Abrufen oder Festlegen des erwarteten Hashwerts des Inhalts.	Zeichenfolge (erforderlich)

ContentLink

Name	Beschreibung	Wert
contentHash	Ruft den Hash ab oder legt den Hash fest.	ContentHash-
Uri	Dient zum Abrufen oder Festlegen des URI des Runbook-Inhalts.	Schnur
Version	Ruft die Version des Inhalts ab oder legt sie fest.	Schnur

Microsoft.Automation/automationAccounts/runbooks

Name	Beschreibung	Wert
Ort	Dient zum Abrufen oder Festlegen des Speicherorts der Ressource.	Schnur
Name	Der Ressourcenname	Schnur Zwänge: Pattern = `^[a-zA-Z][a-zA-Z-_0-9]*$` (erforderlich)
parent_id	Die ID der Ressource, die das übergeordnete Element für diese Ressource ist.	ID für Ressource vom Typ: automationAccounts
Eigenschaften	Dient zum Abrufen oder Festlegen von Runbook-Erstellungs- oder Aktualisierungseigenschaften.	RunbookCreateOrUpdatePropertiesOrRunbookProperties (erforderlich)
Schilder	Ressourcentags	Wörterbuch der Tagnamen und -werte.
Art	Der Ressourcentyp	"Microsoft.Automation/automationAccounts/runbooks@2022-08-08"

RunbookCreateOrUpdateParametersTags

Name	Beschreibung	Wert

RunbookCreateOrUpdatePropertiesOrRunbookProperties

Name	Beschreibung	Wert
Beschreibung	Ruft die Beschreibung des Runbook ab oder legt diese fest.	Schnur
Entwurf	Dient zum Abrufen oder Festlegen der Entwurfs-Runbook-Eigenschaften.	RunbookDraft-
logActivityTrace	Dient zum Abrufen oder Festlegen der Optionen für die Ablaufverfolgung auf Aktivitätsebene des Runbook.	Int
logProgress	Ruft die Statusprotokolloption ab oder legt sie fest.	Bool
logVerbose	Ruft die ausführliche Protokolloption ab oder legt sie fest.	Bool
publishContentLink	Dient zum Abrufen oder Festlegen des veröffentlichten Runbook-Inhaltslinks.	ContentLink-
runbookType	Dient zum Abrufen oder Festlegen des Typs des Runbook.	'Graph' "GraphPowerShell" 'GraphPowerShellWorkflow' "PowerShell" "PowerShellWorkflow" "Python2" "Python3" 'Skript' (erforderlich)

RunbookDraft

Name	Beschreibung	Wert
creationTime	Ruft die Erstellungszeit des Runbook-Entwurfs ab oder legt sie fest.	Schnur
draftContentLink	Dient zum Abrufen oder Festlegen des Entwurfs eines Runbook-Inhaltslinks.	ContentLink-
inEdit	Ruft ab oder legt fest, ob sich runbook im Bearbeitungsmodus befindet.	Bool
lastModifiedTime	Ruft die uhrzeit der letzten Änderung des Runbook-Entwurfs ab oder legt sie fest.	Schnur
outputTypes	Dient zum Abrufen oder Festlegen der Runbook-Ausgabetypen.	string[]
Parameter	Ruft die Entwurfsparameter des Runbook ab oder legt diese fest.	RunbookDraftParameters

RunbookDraftParameters

Name	Beschreibung	Wert

RunbookParameter

Name	Beschreibung	Wert
defaultValue	Dient zum Abrufen oder Festlegen des Standardwerts des Parameters.	Schnur
isMandatory	Dient zum Abrufen oder Festlegen eines booleschen Werts, der angibt, ob der Parameter obligatorisch ist oder nicht.	Bool
Position	Dient zum Abrufen oder Festlegen der Position des Parameters.	Int
Art	Dient zum Abrufen oder Festlegen des Typs des Parameters.	Schnur

Die Zukunft gehört Ihnen

Freigeben über

Microsoft.Automation automationAccounts/runbooks 2022-08-08

Bicep-Ressourcendefinition

Ressourcenformat

Eigenschaftswerte

ContentHash

ContentLink

Microsoft.Automation/automationAccounts/runbooks

RunbookCreateOrUpdateParametersTags

RunbookCreateOrUpdatePropertiesOrRunbookProperties

RunbookDraft

RunbookDraftParameters

RunbookParameter

Verwendungsbeispiele

Azure-Schnellstartbeispiele

ARM-Vorlagenressourcendefinition

Ressourcenformat

Eigenschaftswerte

ContentHash

ContentLink

Microsoft.Automation/automationAccounts/runbooks

RunbookCreateOrUpdateParametersTags

RunbookCreateOrUpdatePropertiesOrRunbookProperties

RunbookDraft

RunbookDraftParameters

RunbookParameter

Verwendungsbeispiele

Azure-Schnellstartvorlagen

Terraform -Ressourcendefinition (AzAPI-Anbieter)

Ressourcenformat

Eigenschaftswerte

ContentHash

ContentLink

Microsoft.Automation/automationAccounts/runbooks

RunbookCreateOrUpdateParametersTags

RunbookCreateOrUpdatePropertiesOrRunbookProperties

RunbookDraft

RunbookDraftParameters

RunbookParameter

Feedback

Zusätzliche Ressourcen