Webhook - Get

Serviço:

Automation

Versão da API:

2024-10-23

Recupere o webhook identificado pelo nome do webhook.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/webhooks/{webhookName}?api-version=2024-10-23

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
automationAccountName	path	True	string	O nome da conta de automação.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Nome de um grupo de Recursos do Azure.
subscriptionId	path	True	string	Obtém credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. O ID da assinatura faz parte do URI de cada chamada de serviço.
webhookName	path	True	string	O nome do webhook.
api-version	query	True	string	Versão da API do cliente.

Respostas

Name	Tipo	Description
200 OK	Webhook	OK
Other Status Codes	ErrorResponse	Resposta de erro de automação descrevendo por que a operação falhou.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

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

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

Get webhook

Pedido de amostra

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/webhooks/TestWebhook?api-version=2024-10-23

Resposta da amostra

Código de estado:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/webhooks/TestWebhook",
  "name": "TestWebhook",
  "properties": {
    "isEnabled": true,
    "expiryTime": "2018-03-29T22:18:13.7002872+00:00",
    "runbook": {
      "name": "TestRunbook"
    },
    "lastInvokedTime": null,
    "runOn": null,
    "parameters": null,
    "uri": "",
    "creationTime": "2017-03-29T22:18:14.6651862+00:00",
    "lastModifiedBy": "",
    "lastModifiedTime": "2017-03-29T22:18:14.6651862+00:00"
  }
}

Definições

Name	Description
createdByType	O tipo de identidade que criou o recurso.
ErrorResponse	Resposta de erro de uma falha de operação
RunbookAssociationProperty	A propriedade runbook associada à entidade.
systemData	Metadados referentes à criação e última modificação do recurso.
Webhook	Definição do tipo webhook.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorResponse

Object

Resposta de erro de uma falha de operação

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

RunbookAssociationProperty

Object

A propriedade runbook associada à entidade.

Name	Tipo	Description
name	string	Obtém ou define o nome do runbook.

systemData

Object

Metadados referentes à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

Webhook

Object

Definição do tipo webhook.

Name	Tipo	Default value	Description
id	string (arm-id)		ID de recurso totalmente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string		O nome do recurso
properties.creationTime	string (date-time)		Obtém ou define o tempo de criação.
properties.description	string		Obtém ou define a descrição.
properties.expiryTime	string (date-time)		Obtém ou define o tempo de expiração.
properties.isEnabled	boolean	False	Obtém ou define o valor do sinalizador ativado do webhook.
properties.lastInvokedTime	string (date-time)		Obtém ou define a última hora invocada.
properties.lastModifiedBy	string		Detalhes do usuário que modificou o Webhook pela última vez
properties.lastModifiedTime	string (date-time)		Obtém ou define a hora da última modificação.
properties.parameters	object		Obtém ou define os parâmetros do trabalho que é criado quando o webhook chama o runbook ao qual está associado.
properties.runOn	string		Obtém ou define o nome do grupo de trabalhadores híbridos no qual o trabalho de webhook será executado.
properties.runbook	RunbookAssociationProperty		Obtém ou define o runbook ao qual o webhook está associado.
properties.uri	string		Obtém ou define o uri do webhook.
systemData	systemData		Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
type	string		O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"