Event Subscriptions - Update

Atualizar uma assinatura de evento.
Atualiza de forma assíncrona uma assinatura de evento existente.

PATCH https://management.azure.com/{scope}/providers/Microsoft.EventGrid/eventSubscriptions/{eventSubscriptionName}?api-version=2020-06-01

Parâmetros de URI

Name In Required Type Description
eventSubscriptionName
path True
  • string

Nome da assinatura do evento a ser atualizada.

scope
path True
  • string

O escopo da assinatura de evento existente. O escopo pode ser uma assinatura, um grupo de recursos ou um recurso de nível superior pertencente a um namespace do provedor de recursos ou a um tópico eventGrid. Por exemplo, use '/subscriptions/{subscriptionId}/' para uma assinatura, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' para um grupo de recursos, e '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' para um recurso e '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' para um tópico eventGrid.

api-version
query True
  • string

Versão da API a ser usada com a solicitação do cliente.

Corpo da solicitação

Name Type Description
deadLetterDestination DeadLetterDestination:

O destino DeadLetter da assinatura do evento.

destination EventSubscriptionDestination:

Informações sobre o destino em que os eventos devem ser entregues para a assinatura do evento.

eventDeliverySchema

O esquema de entrega de eventos para a assinatura do evento.

expirationTimeUtc
  • string

Informações sobre o tempo de expiração da assinatura do evento.

filter

Informações sobre o filtro para a assinatura de evento.

labels
  • string[]

Lista de rótulos definidos pelo usuário.

retryPolicy

A política de nova tentativa para eventos. Isso pode ser usado para configurar o número máximo de tentativas de entrega e tempo de vida para eventos.

Respostas

Name Type Description
201 Created

Solicitação de atualização eventSubscription aceita.

Other Status Codes

Respostas de erro: ***

  • 400 Solicitação Ruim.

  • 500 Erro interno do servidor.

Exemplos

EventSubscriptions_UpdateForCustomTopic
EventSubscriptions_UpdateForResource
EventSubscriptions_UpdateForResourceGroup
EventSubscriptions_UpdateForSubscription

EventSubscriptions_UpdateForCustomTopic

Sample Request

PATCH https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1?api-version=2020-06-01
{
  "destination": {
    "endpointType": "WebHook",
    "properties": {
      "endpointUrl": "https://requestb.in/15ksip71"
    }
  },
  "filter": {
    "isSubjectCaseSensitive": true,
    "subjectBeginsWith": "existingPrefix",
    "subjectEndsWith": "newSuffix"
  },
  "labels": [
    "label1",
    "label2"
  ]
}

Sample Response

{
  "properties": {
    "destination": {
      "properties": {
        "endpointBaseUrl": "https://requestb.in/15ksip71"
      },
      "endpointType": "WebHook"
    },
    "filter": {
      "isSubjectCaseSensitive": true,
      "subjectBeginsWith": "existingPrefix",
      "subjectEndsWith": "newSuffix"
    },
    "labels": [
      "label1",
      "label2"
    ],
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_UpdateForResource

Sample Request

PATCH https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1?api-version=2020-06-01
{
  "destination": {
    "endpointType": "WebHook",
    "properties": {
      "endpointUrl": "https://requestb.in/15ksip71"
    }
  },
  "filter": {
    "isSubjectCaseSensitive": true,
    "subjectBeginsWith": "existingPrefix",
    "subjectEndsWith": "newSuffix"
  },
  "labels": [
    "label1",
    "label2"
  ]
}

Sample Response

{
  "properties": {
    "destination": {
      "properties": {
        "endpointBaseUrl": "https://requestb.in/15ksip71"
      },
      "endpointType": "WebHook"
    },
    "filter": {
      "isSubjectCaseSensitive": true,
      "subjectBeginsWith": "existingPrefix",
      "subjectEndsWith": "newSuffix"
    },
    "labels": [],
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_UpdateForResourceGroup

Sample Request

PATCH https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription2?api-version=2020-06-01
{
  "destination": {
    "endpointType": "EventHub",
    "properties": {
      "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1"
    }
  },
  "filter": {
    "isSubjectCaseSensitive": true,
    "subjectBeginsWith": "existingPrefix",
    "subjectEndsWith": "newSuffix"
  },
  "labels": [
    "label1",
    "label2"
  ]
}

Sample Response

{
  "properties": {
    "destination": {
      "properties": {
        "endpointBaseUrl": "https://requestb.in/15ksip71"
      },
      "endpointType": "WebHook"
    },
    "filter": {
      "isSubjectCaseSensitive": true,
      "subjectBeginsWith": "existingPrefix",
      "subjectEndsWith": "newSuffix"
    },
    "labels": [],
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription2",
  "name": "examplesubscription2",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_UpdateForSubscription

Sample Request

PATCH https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription3?api-version=2020-06-01
{
  "destination": {
    "endpointType": "WebHook",
    "properties": {
      "endpointUrl": "https://requestb.in/15ksip71"
    }
  },
  "filter": {
    "isSubjectCaseSensitive": true,
    "subjectBeginsWith": "existingPrefix",
    "subjectEndsWith": "newSuffix"
  },
  "labels": [
    "label1",
    "label2"
  ]
}

Sample Response

{
  "properties": {
    "destination": {
      "properties": {
        "endpointBaseUrl": "https://requestb.in/15ksip71"
      },
      "endpointType": "WebHook"
    },
    "filter": {
      "isSubjectCaseSensitive": true,
      "subjectBeginsWith": "existingPrefix",
      "subjectEndsWith": "newSuffix"
    },
    "labels": [],
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription3",
  "name": "examplesubscription3",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

Definições

AzureFunctionEventSubscriptionDestination

Informações sobre o destino da função do Azure para uma assinatura de evento.

BoolEqualsAdvancedFilter

Filtro avançado BoolEquals.

createdByType

O tipo de identidade que criou o recurso.

EventDeliverySchema

O esquema de entrega de eventos para a assinatura do evento.

EventHubEventSubscriptionDestination

Informações sobre o destino do hub de eventos para uma assinatura de evento.

EventSubscription

Assinatura do evento

EventSubscriptionFilter

Filtre para a Assinatura de Evento.

EventSubscriptionProvisioningState

Estado de provisionamento da assinatura do evento.

EventSubscriptionUpdateParameters

Propriedades da atualização da Assinatura de Evento.

HybridConnectionEventSubscriptionDestination

Informações sobre o destino de HybridConnection para uma assinatura de evento.

NumberGreaterThanAdvancedFilter

Filtro avançado NumberGreaterThan.

NumberGreaterThanOrEqualsAdvancedFilter

Filtro avançado NumberGreaterThanOrEquals.

NumberInAdvancedFilter

NumberIn Advanced Filter.

NumberLessThanAdvancedFilter

Filtro avançado NumberLessThan.

NumberLessThanOrEqualsAdvancedFilter

Filtro avançado NumberLessThanOrEquals.

NumberNotInAdvancedFilter

Filtro avançado NumberNotIn.

RetryPolicy

Informações sobre a política de nova tentativa para uma assinatura de evento.

ServiceBusQueueEventSubscriptionDestination

Informações sobre o destino do barramento de serviço para uma assinatura de evento.

ServiceBusTopicEventSubscriptionDestination

Informações sobre o destino do tópico do barramento de serviço para uma assinatura de evento.

StorageBlobDeadLetterDestination

Informações sobre o destino de letra morta baseada em blob de armazenamento.

StorageQueueEventSubscriptionDestination

Informações sobre o destino da fila de armazenamento para uma assinatura de evento.

StringBeginsWithAdvancedFilter

Filtro avançado StringBeginsWith.

StringContainsAdvancedFilter

Filtro avançado StringContains.

StringEndsWithAdvancedFilter

Filtro avançado StringEndsWith.

StringInAdvancedFilter

Filtro avançado de cadeia de caracteres.

StringNotInAdvancedFilter

Filtro avançado StringNotIn.

systemData

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

WebHookEventSubscriptionDestination

Informações sobre o destino do webhook para uma assinatura de evento.

AzureFunctionEventSubscriptionDestination

Informações sobre o destino da função do Azure para uma assinatura de evento.

Name Type Description
endpointType string:
  • AzureFunction

Tipo do ponto de extremidade para o destino da assinatura de evento.

properties.maxEventsPerBatch
  • integer

Número máximo de eventos por lote.

properties.preferredBatchSizeInKilobytes
  • integer

Tamanho do lote preferencial em Quilobytes.

properties.resourceId
  • string

A ID do Recurso do Azure que representa o ponto de extremidade do destino da Função do Azure de uma assinatura de evento.

BoolEqualsAdvancedFilter

Filtro avançado BoolEquals.

Name Type Description
key
  • string

O campo/Propriedade no evento com base no qual você deseja filtrar.

operatorType string:
  • BoolEquals

O tipo de operador usado para filtragem, por exemplo, Numbere, StringContains, BoolEquals e outros.

value
  • boolean

O valor do filtro booliano.

createdByType

O tipo de identidade que criou o recurso.

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

EventDeliverySchema

O esquema de entrega de eventos para a assinatura do evento.

Name Type Description
CloudEventSchemaV1_0
  • string
CustomInputSchema
  • string
EventGridSchema
  • string

EventHubEventSubscriptionDestination

Informações sobre o destino do hub de eventos para uma assinatura de evento.

Name Type Description
endpointType string:
  • EventHub

Tipo do ponto de extremidade para o destino da assinatura de evento.

properties.resourceId
  • string

A ID do Recurso do Azure que representa o ponto de extremidade de um destino do Hub de Eventos de uma assinatura de evento.

EventSubscription

Assinatura do evento

Name Type Description
id
  • string

Identificador totalmente qualificado do recurso.

name
  • string

Nome do recurso.

properties.deadLetterDestination DeadLetterDestination:

O destino DeadLetter da assinatura do evento.

properties.destination EventSubscriptionDestination:

Informações sobre o destino em que os eventos devem ser entregues para a assinatura do evento.

properties.eventDeliverySchema

O esquema de entrega de eventos para a assinatura do evento.

properties.expirationTimeUtc
  • string

Hora de expiração da assinatura do evento.

properties.filter

Informações sobre o filtro para a assinatura de evento.

properties.labels
  • string[]

Lista de rótulos definidos pelo usuário.

properties.provisioningState

Estado de provisionamento da assinatura do evento.

properties.retryPolicy

A política de nova tentativa para eventos. Isso pode ser usado para configurar o número máximo de tentativas de entrega e tempo de vida para eventos.

properties.topic
  • string

Nome do tópico da assinatura do evento.

systemData

Os metadados do sistema relacionados ao recurso assinatura de evento.

type
  • string

Tipo do recurso.

EventSubscriptionFilter

Filtre para a Assinatura de Evento.

Name Type Description
advancedFilters AdvancedFilter[]:

Uma matriz de filtros avançados que são usados para filtrar assinaturas de evento.

includedEventTypes
  • string[]

Uma lista de tipos de eventos aplicáveis que precisam fazer parte da assinatura do evento. Se desejar assinar todos os tipos de evento padrão, de definir IncludedEventTypes como nulo.

isSubjectCaseSensitive
  • boolean

Especifica se as propriedades SubjectBeginsWith e SubjectEndsWith do filtro devem ser comparadas de maneira sensível a casos.

subjectBeginsWith
  • string

Uma cadeia de caracteres opcional para filtrar eventos para uma assinatura de evento com base em um prefixo de caminho de recurso. O formato deste depende do publicador dos eventos. Não há suporte para caracteres curinga neste caminho.

subjectEndsWith
  • string

Uma cadeia de caracteres opcional para filtrar eventos para uma assinatura de evento com base em um sufixo de caminho de recurso. Não há suporte para caracteres curinga neste caminho.

EventSubscriptionProvisioningState

Estado de provisionamento da assinatura do evento.

Name Type Description
AwaitingManualAction
  • string
Canceled
  • string
Creating
  • string
Deleting
  • string
Failed
  • string
Succeeded
  • string
Updating
  • string

EventSubscriptionUpdateParameters

Propriedades da atualização da Assinatura de Evento.

Name Type Description
deadLetterDestination DeadLetterDestination:

O destino DeadLetter da assinatura do evento.

destination EventSubscriptionDestination:

Informações sobre o destino em que os eventos devem ser entregues para a assinatura do evento.

eventDeliverySchema

O esquema de entrega de eventos para a assinatura do evento.

expirationTimeUtc
  • string

Informações sobre o tempo de expiração da assinatura do evento.

filter

Informações sobre o filtro para a assinatura de evento.

labels
  • string[]

Lista de rótulos definidos pelo usuário.

retryPolicy

A política de nova tentativa para eventos. Isso pode ser usado para configurar o número máximo de tentativas de entrega e tempo de vida para eventos.

HybridConnectionEventSubscriptionDestination

Informações sobre o destino de HybridConnection para uma assinatura de evento.

Name Type Description
endpointType string:
  • HybridConnection

Tipo do ponto de extremidade para o destino da assinatura de evento.

properties.resourceId
  • string

A ID de recurso do Azure de uma conexão híbrida que é o destino de uma assinatura de evento.

NumberGreaterThanAdvancedFilter

Filtro avançado NumberGreaterThan.

Name Type Description
key
  • string

O campo/Propriedade no evento com base no qual você deseja filtrar.

operatorType string:
  • NumberGreaterThan

O tipo de operador usado para filtragem, por exemplo, Numbere, StringContains, BoolEquals e outros.

value
  • number

O valor do filtro.

NumberGreaterThanOrEqualsAdvancedFilter

Filtro avançado NumberGreaterThanOrEquals.

Name Type Description
key
  • string

O campo/Propriedade no evento com base no qual você deseja filtrar.

operatorType string:
  • NumberGreaterThanOrEquals

O tipo de operador usado para filtragem, por exemplo, Numbere, StringContains, BoolEquals e outros.

value
  • number

O valor do filtro.

NumberInAdvancedFilter

NumberIn Advanced Filter.

Name Type Description
key
  • string

O campo/Propriedade no evento com base no qual você deseja filtrar.

operatorType string:
  • NumberIn

O tipo de operador usado para filtragem, por exemplo, Numbere, StringContains, BoolEquals e outros.

values
  • number[]

O conjunto de valores de filtro.

NumberLessThanAdvancedFilter

Filtro avançado NumberLessThan.

Name Type Description
key
  • string

O campo/Propriedade no evento com base no qual você deseja filtrar.

operatorType string:
  • NumberLessThan

O tipo de operador usado para filtragem, por exemplo, Numbere, StringContains, BoolEquals e outros.

value
  • number

O valor do filtro.

NumberLessThanOrEqualsAdvancedFilter

Filtro avançado NumberLessThanOrEquals.

Name Type Description
key
  • string

O campo/Propriedade no evento com base no qual você deseja filtrar.

operatorType string:
  • NumberLessThanOrEquals

O tipo de operador usado para filtragem, por exemplo, Numbere, StringContains, BoolEquals e outros.

value
  • number

O valor do filtro.

NumberNotInAdvancedFilter

Filtro avançado NumberNotIn.

Name Type Description
key
  • string

O campo/Propriedade no evento com base no qual você deseja filtrar.

operatorType string:
  • NumberNotIn

O tipo de operador usado para filtragem, por exemplo, Numbere, StringContains, BoolEquals e outros.

values
  • number[]

O conjunto de valores de filtro.

RetryPolicy

Informações sobre a política de nova tentativa para uma assinatura de evento.

Name Type Description
eventTimeToLiveInMinutes
  • integer

Tempo de vida (em minutos) para eventos.

maxDeliveryAttempts
  • integer

Número máximo de tentativas de retry de entrega para eventos.

ServiceBusQueueEventSubscriptionDestination

Informações sobre o destino do barramento de serviço para uma assinatura de evento.

Name Type Description
endpointType string:
  • ServiceBusQueue

Tipo do ponto de extremidade para o destino da assinatura de evento.

properties.resourceId
  • string

A ID do Recurso do Azure que representa o ponto de extremidade do destino do Barramento de Serviço de uma assinatura de evento.

ServiceBusTopicEventSubscriptionDestination

Informações sobre o destino do tópico do barramento de serviço para uma assinatura de evento.

Name Type Description
endpointType string:
  • ServiceBusTopic

Tipo do ponto de extremidade para o destino da assinatura de evento.

properties.resourceId
  • string

A ID de recurso do Azure que representa o ponto de extremidade do destino do Tópico do Barramento de Serviço de uma assinatura de evento.

StorageBlobDeadLetterDestination

Informações sobre o destino de letra morta baseada em blob de armazenamento.

Name Type Description
endpointType string:
  • StorageBlob

Tipo do ponto de extremidade para o destino de letra morta

properties.blobContainerName
  • string

O nome do contêiner de blob de armazenamento que é o destino dos eventos de deadletter

properties.resourceId
  • string

A ID do Recurso do Azure da conta de armazenamento que é o destino dos eventos de deadletter

StorageQueueEventSubscriptionDestination

Informações sobre o destino da fila de armazenamento para uma assinatura de evento.

Name Type Description
endpointType string:
  • StorageQueue

Tipo do ponto de extremidade para o destino da assinatura de evento.

properties.queueName
  • string

O nome da fila de armazenamento em uma conta de armazenamento que é o destino de uma assinatura de evento.

properties.resourceId
  • string

A ID do Recurso do Azure da conta de armazenamento que contém a fila que é o destino de uma assinatura de evento.

StringBeginsWithAdvancedFilter

Filtro avançado StringBeginsWith.

Name Type Description
key
  • string

O campo/Propriedade no evento com base no qual você deseja filtrar.

operatorType string:
  • StringBeginsWith

O tipo de operador usado para filtragem, por exemplo, Numbere, StringContains, BoolEquals e outros.

values
  • string[]

O conjunto de valores de filtro.

StringContainsAdvancedFilter

Filtro avançado StringContains.

Name Type Description
key
  • string

O campo/Propriedade no evento com base no qual você deseja filtrar.

operatorType string:
  • StringContains

O tipo de operador usado para filtragem, por exemplo, Numbere, StringContains, BoolEquals e outros.

values
  • string[]

O conjunto de valores de filtro.

StringEndsWithAdvancedFilter

Filtro avançado StringEndsWith.

Name Type Description
key
  • string

O campo/Propriedade no evento com base no qual você deseja filtrar.

operatorType string:
  • StringEndsWith

O tipo de operador usado para filtragem, por exemplo, Numbere, StringContains, BoolEquals e outros.

values
  • string[]

O conjunto de valores de filtro.

StringInAdvancedFilter

Filtro avançado de cadeia de caracteres.

Name Type Description
key
  • string

O campo/Propriedade no evento com base no qual você deseja filtrar.

operatorType string:
  • StringIn

O tipo de operador usado para filtragem, por exemplo, Numbere, StringContains, BoolEquals e outros.

values
  • string[]

O conjunto de valores de filtro.

StringNotInAdvancedFilter

Filtro avançado StringNotIn.

Name Type Description
key
  • string

O campo/Propriedade no evento com base no qual você deseja filtrar.

operatorType string:
  • StringNotIn

O tipo de operador usado para filtragem, por exemplo, Numbere, StringContains, BoolEquals e outros.

values
  • string[]

O conjunto de valores de filtro.

systemData

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

Name Type Description
createdAt
  • string

O data/hora da criação de recursos (UTC).

createdBy
  • string

A identidade que criou o recurso.

createdByType

O tipo de identidade que criou o recurso.

lastModifiedAt
  • string

O data/hora da última modificação do recurso (UTC)

lastModifiedBy
  • string

A identidade que modificou o recurso pela última vez.

lastModifiedByType

O tipo de identidade que modificou o recurso pela última vez.

WebHookEventSubscriptionDestination

Informações sobre o destino do webhook para uma assinatura de evento.

Name Type Description
endpointType string:
  • WebHook

Tipo do ponto de extremidade para o destino da assinatura de evento.

properties.azureActiveDirectoryApplicationIdOrUri
  • string

O Azure Active Directory ID ou URI do aplicativo para obter o token de acesso que será incluído como o token de portador nas solicitações de entrega.

properties.azureActiveDirectoryTenantId
  • string

A Azure Active Directory ID do locatário para obter o token de acesso que será incluído como o token de portador nas solicitações de entrega.

properties.endpointBaseUrl
  • string

A URL base que representa o ponto de extremidade do destino de uma assinatura de evento.

properties.endpointUrl
  • string

A URL que representa o ponto de extremidade do destino de uma assinatura de evento.

properties.maxEventsPerBatch
  • integer

Número máximo de eventos por lote.

properties.preferredBatchSizeInKilobytes
  • integer

Tamanho do lote preferencial em Quilobytes.