Microsoft.AutomationAccounts/runbooks 2023-11-01

Artikel
02/14/2024

Bicep-Ressourcendefinition

Der Ressourcentyp automationAccounts/runbooks kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:

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 Bicep hinzu.

resource symbolicname 'Microsoft.Automation/automationAccounts/runbooks@2023-11-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  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

automationAccounts/runbooks

Name	BESCHREIBUNG	Wert
name	Der Ressourcenname Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in Bicep festlegen.	Zeichenfolge (erforderlich) Zeichenlimit: 1-63 Gültige Zeichen: Alphanumerische Zeichen, Unterstriche und Bindestriche. Beginnen Sie mit einem Buchstaben.
location	Ruft den Speicherort der Ressource ab oder legt ihn fest.	Zeichenfolge
tags	Ruft die an die Ressource angefügten Tags ab oder legt sie fest.	Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
parent	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 vom Typ: automationAccounts
properties	Ruft Runbook-Erstellungs- oder Updateeigenschaften ab oder legt diese fest.	RunbookCreateOrUpdatePropertiesOrRunbookProperties (erforderlich)

RunbookCreateOrUpdatePropertiesOrRunbookProperties

Name	BESCHREIBUNG	Wert
description	Ruft die Beschreibung des Runbooks ab oder legt sie fest.	Zeichenfolge
Entwurf	Ruft die Runbook-Eigenschaften des Entwurfs ab oder legt sie fest.	RunbookDraft
logActivityTrace	Ruft die Ablaufverfolgungsoptionen des Runbooks auf Aktivitätsebene ab oder legt diese fest.	INT
logProgress	Ruft die Statusprotokolloption ab oder legt sie fest.	bool
logVerbose	Ruft die ausführliche Protokolloption ab oder legt sie fest.	bool
publishContentLink	Ruft den link zum veröffentlichten Runbookinhalt ab oder legt diese fest.	Contentlink
runbookType	Ruft den Typ des Runbooks ab oder legt diese fest.	"Graph" 'GraphPowerShell' 'GraphPowerShellWorkflow' 'PowerShell' "PowerShell72" "PowerShellWorkflow" Python2 Python3 "Skript" (erforderlich)

RunbookDraft

Name	BESCHREIBUNG	Wert
creationTime	Ruft die Erstellungszeit des Runbookentwurfs ab oder legt diese fest.	Zeichenfolge
draftContentLink	Ruft den Entwurfs-Runbookinhaltslink ab oder legt diese fest.	Contentlink
inEdit	Ruft ab, ob sich das Runbook im Bearbeitungsmodus befindet, oder legt es fest.	bool
lastModifiedTime	Ruft den Zeitpunkt der letzten Änderung des Runbookentwurfs ab oder legt diese fest.	Zeichenfolge
outputTypes	Ruft die Runbook-Ausgabetypen ab oder legt sie fest.	string[]
parameters	Ruft die Runbookentwurfsparameter ab oder legt sie fest.	RunbookDraftParameters

Contentlink

Name	BESCHREIBUNG	Wert
contentHash	Legt den Hash fest.	ContentHash
uri	Legt den URI des Inhalts fest.	Zeichenfolge
version	Legt die Version des Inhalts fest.	Zeichenfolge

ContentHash

Name	BESCHREIBUNG	Wert
Algorithmus	Ruft den Inhaltshashalgorithmus ab, der zum Hashen des Inhalts verwendet wird, oder legt diesen fest.	Zeichenfolge (erforderlich)
value	Ruft den erwarteten Hashwert des Inhalts ab oder legt diese fest.	Zeichenfolge (erforderlich)

RunbookDraftParameters

Name	BESCHREIBUNG	Wert
{angepasste Eigenschaft}		RunbookParameter

RunbookParameter

Name	BESCHREIBUNG	Wert
defaultValue	Ruft den Standardwert des Parameters ab oder legt diese fest.	Zeichenfolge
isMandatory	Ruft einen booleschen Wert ab, der angibt, ob der Parameter obligatorisch ist oder nicht, oder legt diesen fest.	bool
position	Ruft die Position des Parameters ab oder legt sie fest.	INT
Typ	Ruft den Typ des Parameters ab oder legt ihn fest.	Zeichenfolge

Schnellstartvorlagen

Diesen Ressourcentyp werden in den folgenden Schnellstartvorlagen bereitgestellt.

Vorlage	BESCHREIBUNG
ASR-Runbooks	Stellt Automation-Runbooks für ASR-Wiederherstellungspläne bereit
OMS ASR-Lösung	Aktiviert die ASR (v2)-Lösung in OMS
Azure Resource Optimization (ARO)-Toolkit	Das Azure Resource Optimization Toolkit ist eine dezentrale, native Azure-Lösung, die serverlose Technologien verwendet, um Azure-Ressourcen in Ihrem Abonnement zu optimieren. Die Optimierung erfolgt automatisch für Ihr Abonnement, sobald Sie Ihren eigenen Zeitplan aktivieren oder erstellen, einschließlich neuer Ressourcen. Dies ist ein Azure Automation Konto mit vorkonfigurierten Runbooks und Zeitplänen, die Sie für Ihr Abonnement verwenden können, um Geld zu sparen.
OMS – Azure-Ressourcennutzungslösung	Die Lösung bringt abrechnungsinterne Informationen zu Azure-Ressourcen in OMS. Ressourcenkosten können in unterschiedlichen Währungen und Gebietsschemas angezeigt werden.
OMS : Azure-VM-Inventarlösung	Aktiviert azure VM Inventory Solution in OMS. Solution erfasst den Azure-VM-Bestand zusammen mit Datenträgern, Netzwerkkomponenten, NSG-Regeln und Erweiterungen im OMS-Arbeitsbereich.
OMS-Lösung – Hyper-V-Replikat	Eine Vorlage zum Erstellen einer OMS-Lösung zum Überwachen des Hyper-V-Replikats.
OMS Service Bus-Lösung	Überwacht Azure Service Bus Instanzen
OMS VMM Analytics	Bietet eine einzelne Ansicht der status von Aufträgen über mehrere VMM-Instanzen hinweg, die Ihnen hilft, Einblicke in die Integrität & Leistung dieser Aufträge zu erhalten.
Erstellen eines Azure Automation-Kontos	Diese Vorlage bietet ein Beispiel für das Erstellen eines Azure Automation Kontos und verknüpft es mit einem neuen oder vorhandenen Azure Monitor Log Analytics-Arbeitsbereich.

Ressourcendefinition mit einer ARM-Vorlage

Der Ressourcentyp automationAccounts/runbooks kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:

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": "2023-11-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "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

automationAccounts/runbooks

Name	BESCHREIBUNG	Wert
type	Ressourcentyp	"Microsoft.Automation/automationAccounts/runbooks"
apiVersion	Die Ressourcen-API-Version	'2023-11-01'
name	Der Ressourcenname Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in JSON-ARM-Vorlagen festlegen.	Zeichenfolge (erforderlich) Zeichenlimit: 1-63 Gültige Zeichen: Alphanumerische Zeichen, Unterstriche und Bindestriche. Beginnen Sie mit einem Buchstaben.
location	Ruft den Speicherort der Ressource ab oder legt ihn fest.	Zeichenfolge
tags	Ruft die an die Ressource angefügten Tags ab oder legt sie fest.	Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
properties	Ruft Runbook-Erstellungs- oder Updateeigenschaften ab oder legt diese fest.	RunbookCreateOrUpdatePropertiesOrRunbookProperties (erforderlich)

RunbookCreateOrUpdatePropertiesOrRunbookProperties

Name	BESCHREIBUNG	Wert
description	Ruft die Beschreibung des Runbooks ab oder legt sie fest.	Zeichenfolge
Entwurf	Ruft die Runbook-Eigenschaften des Entwurfs ab oder legt sie fest.	RunbookDraft
logActivityTrace	Ruft die Ablaufverfolgungsoptionen des Runbooks auf Aktivitätsebene ab oder legt diese fest.	INT
logProgress	Ruft die Statusprotokolloption ab oder legt sie fest.	bool
logVerbose	Ruft die ausführliche Protokolloption ab oder legt sie fest.	bool
publishContentLink	Ruft den link zum veröffentlichten Runbookinhalt ab oder legt diese fest.	Contentlink
runbookType	Ruft den Typ des Runbooks ab oder legt diese fest.	"Graph" 'GraphPowerShell' 'GraphPowerShellWorkflow' 'PowerShell' "PowerShell72" "PowerShellWorkflow" Python2 Python3 "Skript" (erforderlich)

RunbookDraft

Name	BESCHREIBUNG	Wert
creationTime	Ruft die Erstellungszeit des Runbookentwurfs ab oder legt diese fest.	Zeichenfolge
draftContentLink	Ruft den Entwurfs-Runbookinhaltslink ab oder legt diese fest.	Contentlink
inEdit	Ruft ab, ob sich das Runbook im Bearbeitungsmodus befindet, oder legt es fest.	bool
lastModifiedTime	Ruft den Zeitpunkt der letzten Änderung des Runbookentwurfs ab oder legt diese fest.	Zeichenfolge
outputTypes	Ruft die Runbook-Ausgabetypen ab oder legt sie fest.	string[]
parameters	Ruft die Runbookentwurfsparameter ab oder legt sie fest.	RunbookDraftParameters

Contentlink

Name	BESCHREIBUNG	Wert
contentHash	Legt den Hash fest.	ContentHash
uri	Legt den URI des Inhalts fest.	Zeichenfolge
version	Legt die Version des Inhalts fest.	Zeichenfolge

ContentHash

Name	BESCHREIBUNG	Wert
Algorithmus	Ruft den Inhaltshashalgorithmus ab, der zum Hashen des Inhalts verwendet wird, oder legt diesen fest.	Zeichenfolge (erforderlich)
value	Ruft den erwarteten Hashwert des Inhalts ab oder legt diese fest.	Zeichenfolge (erforderlich)

RunbookDraftParameters

Name	BESCHREIBUNG	Wert
{angepasste Eigenschaft}		RunbookParameter

RunbookParameter

Name	BESCHREIBUNG	Wert
defaultValue	Ruft den Standardwert des Parameters ab oder legt den Wert fest.	Zeichenfolge
isMandatory	Ruft einen booleschen Wert ab, der angibt, ob der Parameter obligatorisch ist oder nicht, oder legt diesen fest.	bool
position	Ruft die Position des Parameters ab oder legt diese fest.	INT
Typ	Ruft den Typ des Parameters ab oder legt ihn fest.	Zeichenfolge

Schnellstartvorlagen

In den folgenden Schnellstartvorlagen wird dieser Ressourcentyp bereitgestellt.

Vorlage	BESCHREIBUNG
ASR-Runbooks	Stellt Automation-Runbooks für ASR-Wiederherstellungspläne bereit.
OMS ASR-Lösung	Aktiviert die ASR-Lösung (v2) in OMS
Azure Resource Optimization (ARO)-Toolkit	Das Azure Resource Optimization Toolkit ist eine dezentrale, native Azure-Lösung, die serverlose Technologien verwendet, um Azure-Ressourcen für Ihr Abonnement zu optimieren. Die Optimierung erfolgt automatisch für Ihr 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 verwenden können, um Geld zu sparen.
OMS: Azure-Ressourcennutzungslösung	Die Lösung bringt abrechnungsinterne Informationen zu Azure-Ressourcen in OMS ein. Ressourcenkosten können in unterschiedlicher Währung und Gebietsschema angezeigt werden.
OMS: Azure-VM-Bestandslösung	Aktiviert die Azure-VM-Bestandslösung in OMS. Solution erfasst den Azure-VM-Bestand zusammen mit Datenträgern, Netzwerkkomponenten, NSG-Regeln und Erweiterungen im OMS-Arbeitsbereich.
OMS-Lösung – Hyper-V-Replikat	Eine Vorlage zum Erstellen einer OMS-Lösung zum Überwachen des Hyper-V-Replikats.
OMS Service Bus-Lösung	Überwacht Azure Service Bus Instanzen
OMS VMM Analytics	Bietet eine einzelne Ansicht der status von Aufträgen über mehrere VMM-Instanzen hinweg, die Ihnen hilft, Einblicke in die Integrität & Leistung dieser Aufträge zu erhalten.
Erstellen eines Azure Automation-Kontos	Diese Vorlage enthält ein Beispiel für das Erstellen eines Azure Automation Kontos und verknüpft es mit einem neuen oder vorhandenen Azure Monitor Log Analytics-Arbeitsbereich.

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 im Änderungsprotokoll.

Ressourcenformat

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Automation/automationAccounts/runbooks@2023-11-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  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

automationAccounts/runbooks

Name	BESCHREIBUNG	Wert
type	Der Ressourcentyp	"Microsoft.Automation/automationAccounts/runbooks@2023-11-01"
name	Der Ressourcenname	Zeichenfolge (erforderlich) Zeichenlimit: 1-63 Gültige Zeichen: Alphanumerische Zeichen, Unterstriche und Bindestriche. Beginnen Sie mit einem Buchstaben.
location	Ruft den Speicherort der Ressource ab oder legt ihn fest.	Zeichenfolge
parent_id	Die ID der Ressource, die das übergeordnete Element für diese Ressource ist.	ID für Ressource vom Typ automationAccounts
tags	Ruft die an die Ressource angefügten Tags ab oder legt sie fest.	Wörterbuch der Tagnamen und -werte.
properties	Ruft Runbookerstellungs- oder Updateeigenschaften ab oder legt diese fest.	RunbookCreateOrUpdatePropertiesOrRunbookProperties (erforderlich)

RunbookCreateOrUpdatePropertiesOrRunbookProperties

Name	BESCHREIBUNG	Wert
description	Ruft die Beschreibung des Runbooks ab oder legt sie fest.	Zeichenfolge
Entwurf	Ruft die Runbook-Eigenschaften des Entwurfs ab oder legt sie fest.	RunbookDraft
logActivityTrace	Ruft die Ablaufverfolgungsoptionen auf Aktivitätsebene des Runbooks ab oder legt diese fest.	INT
logProgress	Ruft die Statusprotokolloption ab oder legt sie fest.	bool
logVerbose	Ruft die Ausführliche Protokolloption ab oder legt sie fest.	bool
publishContentLink	Ruft den link zum veröffentlichten Runbookinhalt ab oder legt diese fest.	Contentlink
runbookType	Ruft den Typ des Runbooks ab oder legt den Typ des Runbooks fest.	"Graph" "GraphPowerShell" "GraphPowerShellWorkflow" "PowerShell" "PowerShell72" "PowerShellWorkflow" "Python2" "Python3" "Skript" (erforderlich)

RunbookDraft

Name	BESCHREIBUNG	Wert
creationTime	Ruft die Erstellungszeit des Runbookentwurfs ab oder legt diese fest.	Zeichenfolge
draftContentLink	Ruft den Link zum Entwurf des Runbooksinhalts ab oder legt diese fest.	Contentlink
inEdit	Ruft ab oder legt fest, ob sich das Runbook im Bearbeitungsmodus befindet.	bool
lastModifiedTime	Ruft den Zeitpunkt der letzten Änderung des Runbookentwurfs ab oder legt diese fest.	Zeichenfolge
outputTypes	Ruft die Runbook-Ausgabetypen ab oder legt sie fest.	string[]
parameters	Ruft die Runbookentwurfsparameter ab oder legt sie fest.	RunbookDraftParameters

Contentlink

Name	BESCHREIBUNG	Wert
contentHash	Legt den Hash fest.	ContentHash
uri	Legt den URI des Inhalts fest.	Zeichenfolge
version	Legt die Version des Inhalts fest.	Zeichenfolge

ContentHash

Name	BESCHREIBUNG	Wert
Algorithmus	Ruft den Inhaltshashalgorithmus ab, der zum Hashen des Inhalts verwendet wird, oder legt diesen fest.	Zeichenfolge (erforderlich)
value	Ruft den erwarteten Hashwert des Inhalts ab oder legt diese fest.	Zeichenfolge (erforderlich)

RunbookDraftParameters

Name	BESCHREIBUNG	Wert
{angepasste Eigenschaft}		RunbookParameter

RunbookParameter

Name	BESCHREIBUNG	Wert
defaultValue	Ruft den Standardwert des Parameters ab oder legt den Wert fest.	Zeichenfolge
isMandatory	Ruft einen booleschen Wert ab, der angibt, ob der Parameter obligatorisch ist oder nicht, oder legt diesen fest.	bool
position	Ruft die Position des Parameters ab oder legt diese fest.	INT
Typ	Ruft den Typ des Parameters ab oder legt ihn fest.	Zeichenfolge

Freigeben über

Microsoft.AutomationAccounts/runbooks 2023-11-01

Bicep-Ressourcendefinition

Ressourcenformat

Eigenschaftswerte

automationAccounts/runbooks

RunbookCreateOrUpdatePropertiesOrRunbookProperties

RunbookDraft

Contentlink

ContentHash

RunbookDraftParameters

RunbookParameter

Schnellstartvorlagen

Ressourcendefinition mit einer ARM-Vorlage

Ressourcenformat

Eigenschaftswerte

automationAccounts/runbooks

RunbookCreateOrUpdatePropertiesOrRunbookProperties

RunbookDraft

Contentlink

ContentHash

RunbookDraftParameters

RunbookParameter

Schnellstartvorlagen

Terraform-Ressourcendefinition (AzAPI-Anbieter)

Ressourcenformat

Eigenschaftswerte

automationAccounts/runbooks

RunbookCreateOrUpdatePropertiesOrRunbookProperties

RunbookDraft

Contentlink

ContentHash

RunbookDraftParameters

RunbookParameter

Feedback

Zusätzliche Ressourcen