Microsoft.Automation AutomationAccounts/runbook

Artykuł
12/16/2024

Definicja zasobu Bicep

Typ zasobu automationAccounts/runbook można wdrożyć przy użyciu operacji docelowych:

grupy zasobów — zobacz polecenia wdrażania grupy zasobów

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.Automation/automationAccounts/runbook, dodaj następujący kod Bicep do szablonu.

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

Wartości właściwości

ZawartośćHash

Nazwa	Opis	Wartość
algorytm	Pobiera lub ustawia algorytm wyznaczania wartości skrótu zawartości używany do wyznaczania wartości skrótu zawartości.	ciąg (wymagany)
wartość	Pobiera lub ustawia oczekiwaną wartość skrótu zawartości.	ciąg (wymagany)

ContentLink

Nazwa	Opis	Wartość
contentHash	Pobiera lub ustawia skrót.	ContentHash
Uri	Pobiera lub ustawia identyfikator URI zawartości.	struna
Wersja	Pobiera lub ustawia wersję zawartości.	struna

Microsoft.Automation/automationAccounts/runbook

Nazwa	Opis	Wartość
lokalizacja	Pobiera lub ustawia lokalizację zasobu.	struna
nazwa	Nazwa zasobu	struna Ograniczenia: Wzorzec = `^[a-zA-Z][a-zA-Z-_0-9]*$` (wymagane)
rodzic	W Bicep można określić zasób nadrzędny dla zasobu podrzędnego. Tę właściwość należy dodać tylko wtedy, gdy zasób podrzędny jest zadeklarowany poza zasobem nadrzędnym. Aby uzyskać więcej informacji, zobacz Zasób podrzędny poza zasobem nadrzędnym.	Nazwa symboliczna zasobu typu: automationAccounts
Właściwości	Pobiera lub ustawia właściwości elementu Runbook do tworzenia lub aktualizowania.	RunbookCreateOrUpdatePropertiesOrRunbookProperties (wymagane)
Tagi	Tagi zasobów	Słownik nazw tagów i wartości. Zobacz tagi w szablonach

RunbookCreateOrUpdateParametersTags

Nazwa	Opis	Wartość

RunbookCreateOrUpdatePropertiesOrRunbookProperties

Nazwa	Opis	Wartość
opis	Pobiera lub ustawia opis elementu Runbook.	struna
szkic	Pobiera lub ustawia właściwości wersji roboczej elementu Runbook.	RunbookDraft
logActivityTrace	Pobiera lub ustawia opcje śledzenia na poziomie działania elementu Runbook.	Int
logProgress	Pobiera lub ustawia opcję dziennika postępu.	Bool
logVerbose	Pobiera lub ustawia opcję pełnego dziennika.	Bool
publishContentLink	Pobiera lub ustawia link do zawartości opublikowanego elementu Runbook.	ContentLink
RunbookType	Pobiera lub ustawia typ elementu Runbook.	"Graf" "GraphPowerShell" "GraphPowerShellWorkflow" "PowerShell" "PowerShell72" "PowerShellWorkflow" "Python" "Python2" "Python3" "Skrypt" (wymagany)
runtimeEnvironment	Środowisko elementu Runbook.	struna

RunbookDraft

Nazwa	Opis	Wartość
creationTime	Pobiera lub ustawia czas tworzenia wersji roboczej elementu Runbook.	struna
draftContentLink	Pobiera lub ustawia link do zawartości elementu Runbook w wersji roboczej.	ContentLink
inEdit	Pobiera lub ustawia, czy element Runbook jest w trybie edycji.	Bool
lastModifiedTime	Pobiera lub ustawia czas ostatniej modyfikacji wersji roboczej elementu Runbook.	struna
outputTypes	Pobiera lub ustawia typy danych wyjściowych elementu Runbook.	string[]
Parametry	Pobiera lub ustawia parametry wersji roboczej elementu Runbook.	runbookDraftParameters

RunbookDraftParameters

Nazwa	Opis	Wartość

Element RunbookParameter

Nazwa	Opis	Wartość
defaultValue	Pobiera lub ustawia wartość domyślną parametru.	struna
isMandatory	Pobiera lub ustawia wartość logiczną, aby wskazać, czy parametr jest obowiązkowy, czy nie.	Bool
pozycja	Pobierz lub ustawia położenie parametru.	Int
typ	Pobiera lub ustawia typ parametru.	struna

Przykłady użycia

Przykłady szybkiego startu platformy Azure

Poniższe szablony szybkiego startu platformy Azure zawierają przykłady Bicep na potrzeby wdrażania tego typu zasobu.

Plik Bicep	Opis
elementów Runbook usługi ASR	Wdraża elementy Runbook automatyzacji dla planów odzyskiwania usługi ASR

Definicja zasobu szablonu usługi ARM

Typ zasobu automationAccounts/runbook można wdrożyć przy użyciu operacji docelowych:

grupy zasobów — zobacz polecenia wdrażania grupy zasobów

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.Automation/automationAccounts/runbook, dodaj następujący kod JSON do szablonu.

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

Wartości właściwości

ZawartośćHash

Nazwa	Opis	Wartość
algorytm	Pobiera lub ustawia algorytm wyznaczania wartości skrótu zawartości używany do wyznaczania wartości skrótu zawartości.	ciąg (wymagany)
wartość	Pobiera lub ustawia oczekiwaną wartość skrótu zawartości.	ciąg (wymagany)

ContentLink

Nazwa	Opis	Wartość
contentHash	Pobiera lub ustawia skrót.	ContentHash
Uri	Pobiera lub ustawia identyfikator URI zawartości.	struna
Wersja	Pobiera lub ustawia wersję zawartości.	struna

Microsoft.Automation/automationAccounts/runbook

Nazwa	Opis	Wartość
apiVersion	Wersja interfejsu API	'2024-10-23'
lokalizacja	Pobiera lub ustawia lokalizację zasobu.	struna
nazwa	Nazwa zasobu	struna Ograniczenia: Wzorzec = `^[a-zA-Z][a-zA-Z-_0-9]*$` (wymagane)
Właściwości	Pobiera lub ustawia właściwości elementu Runbook do tworzenia lub aktualizowania.	RunbookCreateOrUpdatePropertiesOrRunbookProperties (wymagane)
Tagi	Tagi zasobów	Słownik nazw tagów i wartości. Zobacz tagi w szablonach
typ	Typ zasobu	"Microsoft.Automation/automationAccounts/runbook"

RunbookCreateOrUpdateParametersTags

Nazwa	Opis	Wartość

RunbookCreateOrUpdatePropertiesOrRunbookProperties

Nazwa	Opis	Wartość
opis	Pobiera lub ustawia opis elementu Runbook.	struna
szkic	Pobiera lub ustawia właściwości wersji roboczej elementu Runbook.	RunbookDraft
logActivityTrace	Pobiera lub ustawia opcje śledzenia na poziomie działania elementu Runbook.	Int
logProgress	Pobiera lub ustawia opcję dziennika postępu.	Bool
logVerbose	Pobiera lub ustawia opcję pełnego dziennika.	Bool
publishContentLink	Pobiera lub ustawia link do zawartości opublikowanego elementu Runbook.	ContentLink
RunbookType	Pobiera lub ustawia typ elementu Runbook.	"Graf" "GraphPowerShell" "GraphPowerShellWorkflow" "PowerShell" "PowerShell72" "PowerShellWorkflow" "Python" "Python2" "Python3" "Skrypt" (wymagany)
runtimeEnvironment	Środowisko elementu Runbook.	struna

RunbookDraft

Nazwa	Opis	Wartość
creationTime	Pobiera lub ustawia czas tworzenia wersji roboczej elementu Runbook.	struna
draftContentLink	Pobiera lub ustawia link do zawartości elementu Runbook w wersji roboczej.	ContentLink
inEdit	Pobiera lub ustawia, czy element Runbook jest w trybie edycji.	Bool
lastModifiedTime	Pobiera lub ustawia czas ostatniej modyfikacji wersji roboczej elementu Runbook.	struna
outputTypes	Pobiera lub ustawia typy danych wyjściowych elementu Runbook.	string[]
Parametry	Pobiera lub ustawia parametry wersji roboczej elementu Runbook.	runbookDraftParameters

RunbookDraftParameters

Nazwa	Opis	Wartość

Element RunbookParameter

Nazwa	Opis	Wartość
defaultValue	Pobiera lub ustawia wartość domyślną parametru.	struna
isMandatory	Pobiera lub ustawia wartość logiczną, aby wskazać, czy parametr jest obowiązkowy, czy nie.	Bool
pozycja	Pobierz lub ustawia położenie parametru.	Int
typ	Pobiera lub ustawia typ parametru.	struna

Przykłady użycia

Szablony szybkiego startu platformy Azure

Następujące szablony szybkiego startu platformy Azure wdrożyć ten typ zasobu.

Szablon	Opis
elementów Runbook usługi ASR wdrażanie	Wdraża elementy Runbook automatyzacji dla planów odzyskiwania usługi ASR
zestawu narzędzi Azure Resource Optimization (ARO) Toolkit wdrażanie	Zestaw narzędzi do optymalizacji zasobów platformy Azure to zdecentralizowane, natywne rozwiązanie platformy Azure korzystające z technologii bezserwerowych w celu zoptymalizowania zasobów platformy Azure w ramach subskrypcji. Optymalizacja odbywa się automatycznie w ramach subskrypcji po włączeniu lub utworzeniu własnego harmonogramu, w tym w przypadku nowych zasobów. Jest to konto usługi Azure Automation ze wstępnie skonfigurowanymi elementami Runbook i harmonogramami, których można użyć w ramach subskrypcji, aby rozpocząć oszczędzanie pieniędzy.

Szablon

Opis

elementów Runbook usługi ASR

wdrażanie

Wdraża elementy Runbook automatyzacji dla planów odzyskiwania usługi ASR

zestawu narzędzi Azure Resource Optimization (ARO) Toolkit

wdrażanie

Zestaw narzędzi do optymalizacji zasobów platformy Azure to zdecentralizowane, natywne rozwiązanie platformy Azure korzystające z technologii bezserwerowych w celu zoptymalizowania zasobów platformy Azure w ramach subskrypcji. Optymalizacja odbywa się automatycznie w ramach subskrypcji po włączeniu lub utworzeniu własnego harmonogramu, w tym w przypadku nowych zasobów. Jest to konto usługi Azure Automation ze wstępnie skonfigurowanymi elementami Runbook i harmonogramami, których można użyć w ramach subskrypcji, aby rozpocząć oszczędzanie pieniędzy.

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu automationAccounts/runbook można wdrożyć przy użyciu operacji docelowych:

grupy zasobów

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.Automation/automationAccounts/runbook, dodaj następujący program Terraform do szablonu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Automation/automationAccounts/runbooks@2024-10-23"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    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"
    }
  }
}

Wartości właściwości

ZawartośćHash

Nazwa	Opis	Wartość
algorytm	Pobiera lub ustawia algorytm wyznaczania wartości skrótu zawartości używany do wyznaczania wartości skrótu zawartości.	ciąg (wymagany)
wartość	Pobiera lub ustawia oczekiwaną wartość skrótu zawartości.	ciąg (wymagany)

ContentLink

Nazwa	Opis	Wartość
contentHash	Pobiera lub ustawia skrót.	ContentHash
Uri	Pobiera lub ustawia identyfikator URI zawartości.	struna
Wersja	Pobiera lub ustawia wersję zawartości.	struna

Microsoft.Automation/automationAccounts/runbook

Nazwa	Opis	Wartość
lokalizacja	Pobiera lub ustawia lokalizację zasobu.	struna
nazwa	Nazwa zasobu	struna Ograniczenia: Wzorzec = `^[a-zA-Z][a-zA-Z-_0-9]*$` (wymagane)
parent_id	Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu.	Identyfikator zasobu typu: automationAccounts
Właściwości	Pobiera lub ustawia właściwości elementu Runbook do tworzenia lub aktualizowania.	RunbookCreateOrUpdatePropertiesOrRunbookProperties (wymagane)
Tagi	Tagi zasobów	Słownik nazw tagów i wartości.
typ	Typ zasobu	"Microsoft.Automation/automationAccounts/runbooks@2024-10-23"

RunbookCreateOrUpdateParametersTags

Nazwa	Opis	Wartość

RunbookCreateOrUpdatePropertiesOrRunbookProperties

Nazwa	Opis	Wartość
opis	Pobiera lub ustawia opis elementu Runbook.	struna
szkic	Pobiera lub ustawia właściwości wersji roboczej elementu Runbook.	RunbookDraft
logActivityTrace	Pobiera lub ustawia opcje śledzenia na poziomie działania elementu Runbook.	Int
logProgress	Pobiera lub ustawia opcję dziennika postępu.	Bool
logVerbose	Pobiera lub ustawia opcję pełnego dziennika.	Bool
publishContentLink	Pobiera lub ustawia link do zawartości opublikowanego elementu Runbook.	ContentLink
RunbookType	Pobiera lub ustawia typ elementu Runbook.	"Graf" "GraphPowerShell" "GraphPowerShellWorkflow" "PowerShell" "PowerShell72" "PowerShellWorkflow" "Python" "Python2" "Python3" "Skrypt" (wymagany)
runtimeEnvironment	Środowisko elementu Runbook.	struna

RunbookDraft

Nazwa	Opis	Wartość
creationTime	Pobiera lub ustawia czas tworzenia wersji roboczej elementu Runbook.	struna
draftContentLink	Pobiera lub ustawia link do zawartości elementu Runbook w wersji roboczej.	ContentLink
inEdit	Pobiera lub ustawia, czy element Runbook jest w trybie edycji.	Bool
lastModifiedTime	Pobiera lub ustawia czas ostatniej modyfikacji wersji roboczej elementu Runbook.	struna
outputTypes	Pobiera lub ustawia typy danych wyjściowych elementu Runbook.	string[]
Parametry	Pobiera lub ustawia parametry wersji roboczej elementu Runbook.	runbookDraftParameters

RunbookDraftParameters

Nazwa	Opis	Wartość

Element RunbookParameter

Nazwa	Opis	Wartość
defaultValue	Pobiera lub ustawia wartość domyślną parametru.	struna
isMandatory	Pobiera lub ustawia wartość logiczną, aby wskazać, czy parametr jest obowiązkowy, czy nie.	Bool
pozycja	Pobierz lub ustawia położenie parametru.	Int
typ	Pobiera lub ustawia typ parametru.	struna

Udostępnij za pośrednictwem

Microsoft.Automation AutomationAccounts/runbook

Definicja zasobu Bicep

Format zasobu

Wartości właściwości

ZawartośćHash

ContentLink

Microsoft.Automation/automationAccounts/runbook

RunbookCreateOrUpdateParametersTags

RunbookCreateOrUpdatePropertiesOrRunbookProperties

RunbookDraft

RunbookDraftParameters

Element RunbookParameter

Przykłady użycia

Przykłady szybkiego startu platformy Azure

Definicja zasobu szablonu usługi ARM

Format zasobu

Wartości właściwości

ZawartośćHash

ContentLink

Microsoft.Automation/automationAccounts/runbook

RunbookCreateOrUpdateParametersTags

RunbookCreateOrUpdatePropertiesOrRunbookProperties

RunbookDraft

RunbookDraftParameters

Element RunbookParameter

Przykłady użycia

Szablony szybkiego startu platformy Azure

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Format zasobu

Wartości właściwości

ZawartośćHash

ContentLink

Microsoft.Automation/automationAccounts/runbook

RunbookCreateOrUpdateParametersTags

RunbookCreateOrUpdatePropertiesOrRunbookProperties

RunbookDraft

RunbookDraftParameters

Element RunbookParameter

Opinia

Dodatkowe zasoby