Microsoft.Automation automationAccounts/runbooks

Article
12/16/2024

Définition de ressource Bicep

Le type de ressource automationAccounts/runbooks peut être déployé avec des opérations qui ciblent :

groupes de ressources - Consultez commandes de déploiement de groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.Automation/automationAccounts/runbooks, ajoutez le bicep suivant à votre modèle.

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

Valeurs de propriété

ContentHash

Nom	Description	Valeur
algorithme	Obtient ou définit l’algorithme de hachage de contenu utilisé pour hacher le contenu.	chaîne (obligatoire)
valeur	Obtient ou définit la valeur de hachage attendue du contenu.	chaîne (obligatoire)

ContentLink

Nom	Description	Valeur
contentHash	Obtient ou définit le hachage.	ContentHash
URI	Obtient ou définit l’URI du contenu.	corde
Version	Obtient ou définit la version du contenu.	corde

Microsoft.Automation/automationAccounts/runbooks

Nom	Description	Valeur
emplacement	Obtient ou définit l’emplacement de la ressource.	corde
nom	Nom de la ressource	corde Contraintes: Modèle = `^[a-zA-Z][a-zA-Z-_0-9]*$` (obligatoire)
parent	Dans Bicep, vous pouvez spécifier la ressource parente d’une ressource enfant. Vous devez uniquement ajouter cette propriété lorsque la ressource enfant est déclarée en dehors de la ressource parente. Pour plus d’informations, consultez ressource enfant en dehors de la ressource parente.	Nom symbolique de la ressource de type : automationAccounts
Propriétés	Obtient ou définit les propriétés de création ou de mise à jour du runbook.	RunbookCreateOrUpdatePropertiesOrRunbookProperties (obligatoire)
étiquettes	Balises de ressource	Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles

RunbookCreateOrUpdateParametersTags

Nom	Description	Valeur

RunbookCreateOrUpdatePropertiesOrRunbookProperties

Nom	Description	Valeur
description	Obtient ou définit la description du runbook.	corde
brouillon	Obtient ou définit les propriétés du runbook brouillon.	runbookDraft
logActivityTrace	Obtient ou définit les options de suivi au niveau de l’activité du runbook.	Int
logProgress	Obtient ou définit l’option du journal de progression.	Bool
logVerbose	Obtient ou définit l’option de journal détaillé.	Bool
publishContentLink	Obtient ou définit le lien de contenu du runbook publié.	ContentLink
runbookType	Obtient ou définit le type du runbook.	'Graph' 'GraphPowerShell' 'GraphPowerShellWorkflow' 'PowerShell' 'PowerShell72' 'PowerShellWorkflow' 'Python' 'Python2' 'Python3' 'Script' (obligatoire)
runtimeEnvironment	Environnement du runbook.	corde

RunbookDraft

Nom	Description	Valeur
creationTime	Obtient ou définit l’heure de création du brouillon de runbook.	corde
draftContentLink	Obtient ou définit le lien de contenu du runbook brouillon.	ContentLink
inEdit	Obtient ou définit si le runbook est en mode édition.	Bool
lastModifiedTime	Obtient ou définit l’heure de dernière modification du brouillon du runbook.	corde
outputTypes	Obtient ou définit les types de sortie du runbook.	string[]
Paramètres	Obtient ou définit les paramètres de brouillon de runbook.	RunbookDraftParameters

RunbookDraftParameters

Nom	Description	Valeur

RunbookParameter

Nom	Description	Valeur
defaultValue	Obtient ou définit la valeur par défaut du paramètre.	corde
isMandatory	Obtient ou définit une valeur booléenne pour indiquer si le paramètre est obligatoire ou non.	Bool
position	Obtient ou définit la position du paramètre.	Int
type	Obtient ou définit le type du paramètre.	corde

Exemples de démarrage rapide

Les exemples de démarrage rapide suivants déploient ce type de ressource.

Fichier Bicep	Description
Runbooks ASR	Déploie des runbooks Automation pour les plans de récupération ASR

Définition de ressource de modèle ARM

Le type de ressource automationAccounts/runbooks peut être déployé avec des opérations qui ciblent :

groupes de ressources - Consultez commandes de déploiement de groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.Automation/automationAccounts/runbooks, ajoutez le code JSON suivant à votre modèle.

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

Valeurs de propriété

ContentHash

Nom	Description	Valeur
algorithme	Obtient ou définit l’algorithme de hachage de contenu utilisé pour hacher le contenu.	chaîne (obligatoire)
valeur	Obtient ou définit la valeur de hachage attendue du contenu.	chaîne (obligatoire)

ContentLink

Nom	Description	Valeur
contentHash	Obtient ou définit le hachage.	ContentHash
URI	Obtient ou définit l’URI du contenu.	corde
Version	Obtient ou définit la version du contenu.	corde

Microsoft.Automation/automationAccounts/runbooks

Nom	Description	Valeur
apiVersion	Version de l’API	'2024-10-23'
emplacement	Obtient ou définit l’emplacement de la ressource.	corde
nom	Nom de la ressource	corde Contraintes: Modèle = `^[a-zA-Z][a-zA-Z-_0-9]*$` (obligatoire)
Propriétés	Obtient ou définit les propriétés de création ou de mise à jour du runbook.	RunbookCreateOrUpdatePropertiesOrRunbookProperties (obligatoire)
étiquettes	Balises de ressource	Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
type	Type de ressource	'Microsoft.Automation/automationAccounts/runbooks'

RunbookCreateOrUpdateParametersTags

Nom	Description	Valeur

RunbookCreateOrUpdatePropertiesOrRunbookProperties

Nom	Description	Valeur
description	Obtient ou définit la description du runbook.	corde
brouillon	Obtient ou définit les propriétés du runbook brouillon.	runbookDraft
logActivityTrace	Obtient ou définit les options de suivi au niveau de l’activité du runbook.	Int
logProgress	Obtient ou définit l’option du journal de progression.	Bool
logVerbose	Obtient ou définit l’option de journal détaillé.	Bool
publishContentLink	Obtient ou définit le lien de contenu du runbook publié.	ContentLink
runbookType	Obtient ou définit le type du runbook.	'Graph' 'GraphPowerShell' 'GraphPowerShellWorkflow' 'PowerShell' 'PowerShell72' 'PowerShellWorkflow' 'Python' 'Python2' 'Python3' 'Script' (obligatoire)
runtimeEnvironment	Environnement du runbook.	corde

RunbookDraft

Nom	Description	Valeur
creationTime	Obtient ou définit l’heure de création du brouillon de runbook.	corde
draftContentLink	Obtient ou définit le lien de contenu du runbook brouillon.	ContentLink
inEdit	Obtient ou définit si le runbook est en mode édition.	Bool
lastModifiedTime	Obtient ou définit l’heure de dernière modification du brouillon du runbook.	corde
outputTypes	Obtient ou définit les types de sortie du runbook.	string[]
Paramètres	Obtient ou définit les paramètres de brouillon de runbook.	RunbookDraftParameters

RunbookDraftParameters

Nom	Description	Valeur

RunbookParameter

Nom	Description	Valeur
defaultValue	Obtient ou définit la valeur par défaut du paramètre.	corde
isMandatory	Obtient ou définit une valeur booléenne pour indiquer si le paramètre est obligatoire ou non.	Bool
position	Obtient ou définit la position du paramètre.	Int
type	Obtient ou définit le type du paramètre.	corde

Modèles de démarrage rapide

Les modèles de démarrage rapide suivants déploient ce type de ressource.

Modèle

Description

Runbooks ASR

Déploie des runbooks Automation pour les plans de récupération ASR

kit de ressources Azure (ARO) Toolkit

Azure Resource Optimization Toolkit est une solution Azure décentralisée et native utilisant des technologies serverless pour optimiser les ressources Azure sur votre abonnement. L’optimisation se produit automatiquement sur votre abonnement une fois que vous avez activé ou créé votre propre planification, y compris sur les nouvelles ressources. Il s’agit d’un compte Azure Automation avec des runbooks préconfigurés et des planifications que vous pouvez utiliser sur votre abonnement pour commencer à économiser de l’argent.

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource automationAccounts/runbooks peut être déployé avec des opérations qui ciblent :

groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.Automation/automationAccounts/runbooks, ajoutez le terraform suivant à votre modèle.

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

Valeurs de propriété

ContentHash

Nom	Description	Valeur
algorithme	Obtient ou définit l’algorithme de hachage de contenu utilisé pour hacher le contenu.	chaîne (obligatoire)
valeur	Obtient ou définit la valeur de hachage attendue du contenu.	chaîne (obligatoire)

ContentLink

Nom	Description	Valeur
contentHash	Obtient ou définit le hachage.	ContentHash
URI	Obtient ou définit l’URI du contenu.	corde
Version	Obtient ou définit la version du contenu.	corde

Microsoft.Automation/automationAccounts/runbooks

Nom	Description	Valeur
emplacement	Obtient ou définit l’emplacement de la ressource.	corde
nom	Nom de la ressource	corde Contraintes: Modèle = `^[a-zA-Z][a-zA-Z-_0-9]*$` (obligatoire)
parent_id	ID de la ressource qui est le parent de cette ressource.	ID de ressource de type : automationAccounts
Propriétés	Obtient ou définit les propriétés de création ou de mise à jour du runbook.	RunbookCreateOrUpdatePropertiesOrRunbookProperties (obligatoire)
étiquettes	Balises de ressource	Dictionnaire de noms et de valeurs d’étiquettes.
type	Type de ressource	« Microsoft.Automation/automationAccounts/runbooks@2024-10-23 »

RunbookCreateOrUpdateParametersTags

Nom	Description	Valeur

RunbookCreateOrUpdatePropertiesOrRunbookProperties

Nom	Description	Valeur
description	Obtient ou définit la description du runbook.	corde
brouillon	Obtient ou définit les propriétés du runbook brouillon.	runbookDraft
logActivityTrace	Obtient ou définit les options de suivi au niveau de l’activité du runbook.	Int
logProgress	Obtient ou définit l’option du journal de progression.	Bool
logVerbose	Obtient ou définit l’option de journal détaillé.	Bool
publishContentLink	Obtient ou définit le lien de contenu du runbook publié.	ContentLink
runbookType	Obtient ou définit le type du runbook.	'Graph' 'GraphPowerShell' 'GraphPowerShellWorkflow' 'PowerShell' 'PowerShell72' 'PowerShellWorkflow' 'Python' 'Python2' 'Python3' 'Script' (obligatoire)
runtimeEnvironment	Environnement du runbook.	corde

RunbookDraft

Nom	Description	Valeur
creationTime	Obtient ou définit l’heure de création du brouillon de runbook.	corde
draftContentLink	Obtient ou définit le lien de contenu du runbook brouillon.	ContentLink
inEdit	Obtient ou définit si le runbook est en mode édition.	Bool
lastModifiedTime	Obtient ou définit l’heure de dernière modification du brouillon du runbook.	corde
outputTypes	Obtient ou définit les types de sortie du runbook.	string[]
Paramètres	Obtient ou définit les paramètres de brouillon de runbook.	RunbookDraftParameters

RunbookDraftParameters

Nom	Description	Valeur

RunbookParameter

Nom	Description	Valeur
defaultValue	Obtient ou définit la valeur par défaut du paramètre.	corde
isMandatory	Obtient ou définit une valeur booléenne pour indiquer si le paramètre est obligatoire ou non.	Bool
position	Obtient ou définit la position du paramètre.	Int
type	Obtient ou définit le type du paramètre.	corde

Partager via

Microsoft.Automation automationAccounts/runbooks

Définition de ressource Bicep

Format de ressource

Valeurs de propriété

ContentHash

ContentLink

Microsoft.Automation/automationAccounts/runbooks

RunbookCreateOrUpdateParametersTags

RunbookCreateOrUpdatePropertiesOrRunbookProperties

RunbookDraft

RunbookDraftParameters

RunbookParameter

Exemples de démarrage rapide

Définition de ressource de modèle ARM

Format de ressource

Valeurs de propriété

ContentHash

ContentLink

Microsoft.Automation/automationAccounts/runbooks

RunbookCreateOrUpdateParametersTags

RunbookCreateOrUpdatePropertiesOrRunbookProperties

RunbookDraft

RunbookDraftParameters

RunbookParameter

Modèles de démarrage rapide

Définition de ressource Terraform (fournisseur AzAPI)

Format de ressource

Valeurs de propriété

ContentHash

ContentLink

Microsoft.Automation/automationAccounts/runbooks

RunbookCreateOrUpdateParametersTags

RunbookCreateOrUpdatePropertiesOrRunbookProperties

RunbookDraft

RunbookDraftParameters

RunbookParameter

Commentaires

Ressources supplémentaires