Runbook - Update

Referência

Serviço:: Automation

Versão da API:: 2023-11-01

Atualize o runbook identificado pelo nome do runbook.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
automationAccountName	path	True	string	O nome da conta de automação.
resourceGroupName	path	True	string	Nome de um grupo de recursos do Azure. Padrão Regex: `^[-\w\._]+$`
runbookName	path	True	string	O nome do runbook. Padrão Regex: `^[a-zA-Z][a-zA-Z-_0-9]*$`
subscriptionId	path	True	string	Obtém as credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão da API do cliente.

Corpo da solicitação

Nome	Tipo	Description
location	string	Obtém ou define o local do recurso.
name	string	Obtém ou define o nome do recurso.
properties.description	string	Obtém ou define a descrição do runbook.
properties.logActivityTrace	integer	Obtém ou define as opções de rastreamento no nível da atividade do runbook.
properties.logProgress	boolean	Obtém ou define a opção de log de progresso.
properties.logVerbose	boolean	Obtém ou define a opção de log detalhado.
tags	object	Obtém ou define as marcas anexadas ao recurso.

Respostas

Nome	Tipo	Description
200 OK	Runbook	OK
Other Status Codes	ErrorResponse	Resposta de erro de automação que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Update runbook

Solicitação de exemplo

HTTP

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

{
  "properties": {
    "description": "Updated Description of the Runbook",
    "logVerbose": false,
    "logProgress": true,
    "logActivityTrace": 1
  }
}

Resposta de exemplo

Código de status:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/runbooks/Get-AzureVMTutorial",
  "name": "Get-AzureVMTutorial",
  "type": "Microsoft.Automation/AutomationAccounts/Runbooks",
  "location": "East US 2",
  "tags": {
    "tag01": "value01",
    "tag02": "value02"
  },
  "etag": "\"636265044994500000\"",
  "properties": {
    "description": "Updated Description of the Runbook",
    "logVerbose": false,
    "logProgress": true,
    "logActivityTrace": 1,
    "runbookType": "PowerShellWorkflow",
    "parameters": {},
    "state": "Published",
    "jobCount": 0,
    "provisioningState": "Succeeded",
    "outputTypes": [],
    "creationTime": "2017-03-30T21:01:33.777+00:00",
    "lastModifiedBy": "myEmaild@microsoft.com",
    "lastModifiedTime": "2017-03-30T21:01:39.45+00:00"
  }
}

Definições

Nome	Description
ContentHash	Definição do tipo de propriedade do runbook.
ContentLink	Definição do link de conteúdo.
ErrorResponse	Resposta de erro de uma falha de operação
Runbook	Definição do tipo de runbook.
RunbookDraft
RunbookParameter	Definição do tipo de parâmetro runbook.
RunbookProvisioningState	Obtém ou define o estado de provisionamento do runbook.
RunbookState	Obtém ou define o estado do runbook.
RunbookTypeEnum	Obtém ou define o tipo do runbook.
RunbookUpdateParameters	Os parâmetros fornecidos para a operação de runbook de atualização.

ContentHash

Definição do tipo de propriedade do runbook.

Nome	Tipo	Description
algorithm	string	Obtém ou define o algoritmo de hash de conteúdo usado para hash do conteúdo.
value	string	Obtém ou define o valor de hash esperado do conteúdo.

ContentLink

Definição do link de conteúdo.

Nome	Tipo	Description
contentHash	ContentHash	Define o hash.
uri	string	Define o URI do conteúdo.
version	string	Define a versão do conteúdo.

ErrorResponse

Resposta de erro de uma falha de operação

Nome	Tipo	Description
code	string	Código do erro
message	string	Mensagem de erro indicando por que a operação falhou.

Runbook

Definição do tipo de runbook.

Nome	Tipo	Description
etag	string	Obtém ou define a etag do recurso.
id	string	ID de recurso totalmente qualificada para o recurso
location	string	A região do Azure em que o recurso reside
name	string	O nome do recurso
properties.creationTime	string	Obtém ou define a hora de criação.
properties.description	string	Obtém ou define a descrição.
properties.draft	RunbookDraft	Obtém ou define as propriedades do runbook de rascunho.
properties.jobCount	integer	Obtém ou define a contagem de trabalhos do runbook.
properties.lastModifiedBy	string	Obtém ou define o último modificado por.
properties.lastModifiedTime	string	Obtém ou define a hora da última modificação.
properties.logActivityTrace	integer	Obtém ou define a opção para registrar o rastreamento de atividade do runbook.
properties.logProgress	boolean	Obtém ou define a opção de log de progresso.
properties.logVerbose	boolean	Obtém ou define a opção de log detalhado.
properties.outputTypes	string[]	Obtém ou define os tipos de saída do runbook.
properties.parameters	<string, RunbookParameter>	Obtém ou define os parâmetros do runbook.
properties.provisioningState	RunbookProvisioningState	Obtém ou define o estado de provisionamento do runbook.
properties.publishContentLink	ContentLink	Obtém ou define o link de conteúdo do runbook publicado.
properties.runbookType	RunbookTypeEnum	Obtém ou define o tipo do runbook.
properties.state	RunbookState	Obtém ou define o estado do runbook.
tags	object	Marcas de recurso.
type	string	Tipo do recurso.

RunbookDraft

Nome	Tipo	Description
creationTime	string	Obtém ou define a hora de criação do rascunho do runbook.
draftContentLink	ContentLink	Obtém ou define o link de conteúdo do runbook de rascunho.
inEdit	boolean	Obtém ou define se o runbook está no modo de edição.
lastModifiedTime	string	Obtém ou define a hora da última modificação do rascunho do runbook.
outputTypes	string[]	Obtém ou define os tipos de saída do runbook.
parameters	<string, RunbookParameter>	Obtém ou define os parâmetros de rascunho do runbook.

RunbookParameter

Definição do tipo de parâmetro runbook.

Nome	Tipo	Description
defaultValue	string	Obtém ou define o valor padrão do parâmetro.
isMandatory	boolean	Obtém ou define um valor booliano para indicar se o parâmetro é obrigatório ou não.
position	integer	Obtém ou define a posição do parâmetro.
type	string	Obtém ou define o tipo do parâmetro.

RunbookProvisioningState

Obtém ou define o estado de provisionamento do runbook.

Nome	Tipo	Description
Succeeded	string

RunbookState

Obtém ou define o estado do runbook.

Nome	Tipo	Description
Edit	string
New	string
Published	string

RunbookTypeEnum

Obtém ou define o tipo do runbook.

Nome	Tipo	Description
Graph	string
GraphPowerShell	string
GraphPowerShellWorkflow	string
PowerShell	string
PowerShell72	string
PowerShellWorkflow	string
Python2	string
Python3	string
Script	string

RunbookUpdateParameters

Os parâmetros fornecidos para a operação de runbook de atualização.

Nome	Tipo	Description
location	string	Obtém ou define o local do recurso.
name	string	Obtém ou define o nome do recurso.
properties.description	string	Obtém ou define a descrição do runbook.
properties.logActivityTrace	integer	Obtém ou define as opções de rastreamento no nível da atividade do runbook.
properties.logProgress	boolean	Obtém ou define a opção de log de progresso.
properties.logVerbose	boolean	Obtém ou define a opção de log detalhado.
tags	object	Obtém ou define as marcas anexadas ao recurso.

Compartilhar via