Partager via


Runbook - List By Automation Account

Récupérez une liste de runbooks.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks?api-version=2023-11-01

Paramètres URI

Nom Dans Obligatoire Type Description
automationAccountName
path True

string

Nom du compte Automation.

resourceGroupName
path True

string

Nom d’un groupe de ressources Azure.

Modèle d’expression régulière: ^[-\w\._]+$

subscriptionId
path True

string

Obtient les informations d'identification d'abonnement qui identifient l'abonnement Microsoft Azure de manière unique. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.

api-version
query True

string

Version de l’API cliente.

Réponses

Nom Type Description
200 OK

RunbookListResult

Ok

Other Status Codes

ErrorResponse

Réponse d’erreur Automation décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Exemples

List runbooks by automation account

Exemple de requête

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/runbooks?api-version=2023-11-01

Exemple de réponse

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/runbooks/ASR-AddPublicIp",
      "location": "East US 2",
      "name": "ASR-AddPublicIp",
      "type": "Microsoft.Automation/AutomationAccounts/Runbooks",
      "properties": {
        "runbookType": "PowerShell",
        "state": "Published",
        "logVerbose": true,
        "logProgress": true,
        "logActivityTrace": 1,
        "creationTime": "2017-03-28T21:32:25.78+00:00",
        "lastModifiedTime": "2017-03-28T21:32:25.81+00:00"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/runbooks/AutoExport",
      "location": "East US 2",
      "name": "AutoExport",
      "type": "Microsoft.Automation/AutomationAccounts/Runbooks",
      "properties": {
        "runbookType": "PowerShell",
        "state": "Published",
        "logVerbose": true,
        "logProgress": true,
        "logActivityTrace": 1,
        "creationTime": "2017-03-28T21:32:27.327+00:00",
        "lastModifiedTime": "2017-03-28T21:32:27.327+00:00"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/runbooks/Get-AzureVMTutorial",
      "location": "East US 2",
      "name": "Get-AzureVMTutorial",
      "type": "Microsoft.Automation/AutomationAccounts/Runbooks",
      "properties": {
        "runbookType": "PowerShellWorkflow",
        "state": "Published",
        "logVerbose": false,
        "logProgress": true,
        "logActivityTrace": 1,
        "creationTime": "2017-03-28T21:32:23.75+00:00",
        "lastModifiedTime": "2017-03-28T21:32:23.75+00:00"
      }
    }
  ]
}

Définitions

Nom Description
ContentHash

Définition du type de propriété runbook.

ContentLink

Définition du lien de contenu.

ErrorResponse

Réponse d’erreur d’un échec d’opération

Runbook

Définition du type de runbook.

RunbookDraft
RunbookListResult

Modèle de réponse pour l’opération de runbook de liste.

RunbookParameter

Définition du type de paramètre de runbook.

RunbookProvisioningState

Obtient ou définit l’état d’approvisionnement du runbook.

RunbookState

Obtient ou définit l’état du runbook.

RunbookTypeEnum

Obtient ou définit le type du runbook.

ContentHash

Définition du type de propriété runbook.

Nom Type Description
algorithm

string

Obtient ou définit l’algorithme de hachage de contenu utilisé pour hacher le contenu.

value

string

Obtient ou définit la valeur de hachage attendue du contenu.

Définition du lien de contenu.

Nom Type Description
contentHash

ContentHash

Définit le hachage.

uri

string

Définit l’URI du contenu.

version

string

Définit la version du contenu.

ErrorResponse

Réponse d’erreur d’un échec d’opération

Nom Type Description
code

string

Code d'erreur

message

string

Message d’erreur indiquant la raison de l’échec de l’opération.

Runbook

Définition du type de runbook.

Nom Type Description
etag

string

Obtient ou définit l’etag de la ressource.

id

string

ID de ressource complet pour la ressource

location

string

Région Azure où réside la ressource

name

string

nom de la ressource.

properties.creationTime

string

Obtient ou définit l’heure de création.

properties.description

string

Obtient ou définit la description.

properties.draft

RunbookDraft

Obtient ou définit les propriétés du runbook brouillon.

properties.jobCount

integer

Obtient ou définit le nombre de travaux du runbook.

properties.lastModifiedBy

string

Obtient ou définit la dernière modification par.

properties.lastModifiedTime

string

Obtient ou définit l’heure de la dernière modification.

properties.logActivityTrace

integer

Obtient ou définit l’option permettant de journaliser la trace d’activité du runbook.

properties.logProgress

boolean

Obtient ou définit l’option du journal de progression.

properties.logVerbose

boolean

Obtient ou définit l’option de journal détaillé.

properties.outputTypes

string[]

Obtient ou définit les types de sortie de runbook.

properties.parameters

<string,  RunbookParameter>

Obtient ou définit les paramètres du runbook.

properties.provisioningState

RunbookProvisioningState

Obtient ou définit l’état d’approvisionnement du runbook.

properties.publishContentLink

ContentLink

Obtient ou définit le lien de contenu du runbook publié.

properties.runbookType

RunbookTypeEnum

Obtient ou définit le type du runbook.

properties.state

RunbookState

Obtient ou définit l’état du runbook.

tags

object

Balises de ressource.

type

string

Type de la ressource.

RunbookDraft

Nom Type Description
creationTime

string

Obtient ou définit l’heure de création du brouillon de runbook.

draftContentLink

ContentLink

Obtient ou définit le lien de contenu du runbook brouillon.

inEdit

boolean

Obtient ou définit si le runbook est en mode édition.

lastModifiedTime

string

Obtient ou définit l’heure de la dernière modification du brouillon de runbook.

outputTypes

string[]

Obtient ou définit les types de sortie de runbook.

parameters

<string,  RunbookParameter>

Obtient ou définit les paramètres de brouillon de runbook.

RunbookListResult

Modèle de réponse pour l’opération de runbook de liste.

Nom Type Description
nextLink

string

Obtient ou définit le lien suivant.

value

Runbook[]

Obtient ou définit une liste de runbooks.

RunbookParameter

Définition du type de paramètre de runbook.

Nom Type Description
defaultValue

string

Obtient ou définit la valeur par défaut du paramètre.

isMandatory

boolean

Obtient ou définit une valeur booléenne pour indiquer si le paramètre est obligatoire ou non.

position

integer

Obtient ou définit la position du paramètre.

type

string

Obtient ou définit le type du paramètre.

RunbookProvisioningState

Obtient ou définit l’état d’approvisionnement du runbook.

Nom Type Description
Succeeded

string

RunbookState

Obtient ou définit l’état du runbook.

Nom Type Description
Edit

string

New

string

Published

string

RunbookTypeEnum

Obtient ou définit le type du runbook.

Nom Type Description
Graph

string

GraphPowerShell

string

GraphPowerShellWorkflow

string

PowerShell

string

PowerShell72

string

PowerShellWorkflow

string

Python2

string

Python3

string

Script

string