Partilhar via


Event Subscriptions - Create Or Update

Criar ou atualizar uma subscrição de evento.
Assíncronamente cria uma nova subscrição de evento ou atualiza uma subscrição de evento existente com base no âmbito especificado.

PUT https://management.azure.com/{scope}/providers/Microsoft.EventGrid/eventSubscriptions/{eventSubscriptionName}?api-version=2022-06-15

Parâmetros do URI

Name Em Necessário Tipo Description
eventSubscriptionName
path True

string

Nome da subscrição do evento. Os nomes das subscrições de eventos têm de ter entre 3 e 64 carateres de comprimento e devem utilizar apenas letras alfanuméricas.

scope
path True

string

O identificador do recurso para o qual a subscrição de eventos tem de ser criada ou atualizada. O âmbito pode ser uma subscrição, um grupo de recursos ou um recurso de nível superior pertencente a um espaço de nomes de fornecedor de recursos ou um tópico eventGrid. Por exemplo, utilize "/subscriptions/{subscriptionId}/" para uma subscrição, "/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 utilizar com o pedido de cliente.

Corpo do Pedido

Name Tipo Description
properties.deadLetterDestination DeadLetterDestination:

StorageBlobDeadLetterDestination

O destino da letra não entregue da subscrição do evento. Qualquer evento que não possa ser entregue no destino do respetivo destino é enviado para o destino da letra não entregue. Utiliza a identidade do Azure Event Grid para adquirir os tokens de autenticação que estão a ser utilizados durante a entrega/sem letras.

properties.deadLetterWithResourceIdentity

DeadLetterWithResourceIdentity

O destino da letra não entregue da subscrição do evento. Qualquer evento que não possa ser entregue no destino do respetivo destino é enviado para o destino da letra não entregue. Utiliza a configuração da identidade gerida no recurso principal (nomeadamente, tópico ou domínio) para adquirir os tokens de autenticação que estão a ser utilizados durante a entrega/letra não entregue.

properties.deliveryWithResourceIdentity

DeliveryWithResourceIdentity

Informações sobre o destino onde os eventos têm de ser entregues para a subscrição do evento. Utiliza a configuração da identidade gerida no recurso principal (nomeadamente, tópico ou domínio) para adquirir os tokens de autenticação que estão a ser utilizados durante a entrega/letra não entregue.

properties.destination EventSubscriptionDestination:

Informações sobre o destino onde os eventos têm de ser entregues para a subscrição do evento. Utiliza a identidade do Azure Event Grid para adquirir os tokens de autenticação que estão a ser utilizados durante a entrega/sem letras.

properties.eventDeliverySchema

EventDeliverySchema

O esquema de entrega de eventos para a subscrição do evento.

properties.expirationTimeUtc

string

Tempo de expiração da subscrição do evento.

properties.filter

EventSubscriptionFilter

Informações sobre o filtro da subscrição do evento.

properties.labels

string[]

Lista de etiquetas definidas pelo utilizador.

properties.retryPolicy

RetryPolicy

A política de repetição para eventos. Isto pode ser utilizado para configurar o número máximo de tentativas de entrega e tempo de transmissão em direto para eventos.

Respostas

Name Tipo Description
201 Created

EventSubscription

Pedido EventSubscription CreateOrUpdate aceite.

Other Status Codes

Respostas de Erro: ***

  • 400 Pedido Incorreto.

  • Erro de Servidor Interno 500.

Exemplos

EventSubscriptions_CreateOrUpdateForCustomTopic
EventSubscriptions_CreateOrUpdateForCustomTopic_AzureFunctionDestination
EventSubscriptions_CreateOrUpdateForCustomTopic_EventHubDestination
EventSubscriptions_CreateOrUpdateForCustomTopic_HybridConnectionDestination
EventSubscriptions_CreateOrUpdateForCustomTopic_ServiceBusQueueDestination
EventSubscriptions_CreateOrUpdateForCustomTopic_ServiceBusTopicDestination
EventSubscriptions_CreateOrUpdateForCustomTopic_StorageQueueDestination
EventSubscriptions_CreateOrUpdateForCustomTopic_WebhookDestination
EventSubscriptions_CreateOrUpdateForResource
EventSubscriptions_CreateOrUpdateForResourceGroup
EventSubscriptions_CreateOrUpdateForSubscription

EventSubscriptions_CreateOrUpdateForCustomTopic

Pedido de amostra

PUT https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1?api-version=2022-06-15

{
  "properties": {
    "destination": {
      "endpointType": "EventHub",
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1"
      }
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    }
  }
}

Resposta da amostra

{
  "properties": {
    "destination": {
      "properties": {
        "endpointBaseUrl": "https://requestb.in/15ksip71"
      },
      "endpointType": "WebHook"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic1"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_CreateOrUpdateForCustomTopic_AzureFunctionDestination

Pedido de amostra

PUT https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1?api-version=2022-06-15

{
  "properties": {
    "destination": {
      "endpointType": "AzureFunction",
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Web/sites/ContosoSite/funtions/ContosoFunc"
      }
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "deadLetterDestination": {
      "endpointType": "StorageBlob",
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg",
        "blobContainerName": "contosocontainer"
      }
    }
  }
}

Resposta da amostra

{
  "properties": {
    "destination": {
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Web/sites/ContosoSite/funtions/ContosoFunc"
      },
      "endpointType": "AzureFunction"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1",
    "provisioningState": "Creating",
    "labels": null,
    "deadLetterDestination": {
      "endpointType": "StorageBlob",
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg",
        "blobContainerName": "contosocontainer"
      }
    }
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_CreateOrUpdateForCustomTopic_EventHubDestination

Pedido de amostra

PUT https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1?api-version=2022-06-15

{
  "properties": {
    "destination": {
      "endpointType": "EventHub",
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1"
      }
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "deadLetterDestination": {
      "endpointType": "StorageBlob",
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg",
        "blobContainerName": "contosocontainer"
      }
    }
  }
}

Resposta da amostra

{
  "properties": {
    "destination": {
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1"
      },
      "endpointType": "EventHub"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1",
    "provisioningState": "Creating",
    "labels": null,
    "deadLetterDestination": {
      "endpointType": "StorageBlob",
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg",
        "blobContainerName": "contosocontainer"
      }
    }
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_CreateOrUpdateForCustomTopic_HybridConnectionDestination

Pedido de amostra

PUT https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1?api-version=2022-06-15

{
  "properties": {
    "destination": {
      "endpointType": "HybridConnection",
      "properties": {
        "resourceId": "/subscriptions/d33c5f7a-02ea-40f4-bf52-07f17e84d6a8/resourceGroups/TestRG/providers/Microsoft.Relay/namespaces/ContosoNamespace/hybridConnections/HC1"
      }
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "deadLetterDestination": {
      "endpointType": "StorageBlob",
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg",
        "blobContainerName": "contosocontainer"
      }
    }
  }
}

Resposta da amostra

{
  "properties": {
    "destination": {
      "properties": {
        "resourceId": "/subscriptions/d33c5f7a-02ea-40f4-bf52-07f17e84d6a8/resourceGroups/TestRG/providers/Microsoft.Relay/namespaces/ContosoNamespace/hybridConnections/HC1"
      },
      "endpointType": "HybridConnection"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1",
    "provisioningState": "Creating",
    "labels": null,
    "deadLetterDestination": {
      "endpointType": "StorageBlob",
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg",
        "blobContainerName": "contosocontainer"
      }
    }
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_CreateOrUpdateForCustomTopic_ServiceBusQueueDestination

Pedido de amostra

PUT https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1?api-version=2022-06-15

{
  "properties": {
    "destination": {
      "endpointType": "ServiceBusQueue",
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.ServiceBus/namespaces/ContosoNamespace/queues/SBQ"
      }
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "deadLetterDestination": {
      "endpointType": "StorageBlob",
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg",
        "blobContainerName": "contosocontainer"
      }
    }
  }
}

Resposta da amostra

{
  "properties": {
    "destination": {
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.ServiceBus/namespaces/ContosoNamespace/queues/SBQ"
      },
      "endpointType": "ServiceBusQueue"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1",
    "provisioningState": "Creating",
    "labels": null,
    "deadLetterDestination": {
      "endpointType": "StorageBlob",
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg",
        "blobContainerName": "contosocontainer"
      }
    }
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_CreateOrUpdateForCustomTopic_ServiceBusTopicDestination

Pedido de amostra

PUT https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1?api-version=2022-06-15

{
  "properties": {
    "destination": {
      "endpointType": "ServiceBusTopic",
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.ServiceBus/namespaces/ContosoNamespace/topics/SBT"
      }
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "deadLetterDestination": {
      "endpointType": "StorageBlob",
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg",
        "blobContainerName": "contosocontainer"
      }
    }
  }
}

Resposta da amostra

{
  "properties": {
    "destination": {
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.ServiceBus/namespaces/ContosoNamespace/topics/SBT"
      },
      "endpointType": "ServiceBusTopic"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1",
    "provisioningState": "Creating",
    "labels": null,
    "deadLetterDestination": {
      "endpointType": "StorageBlob",
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg",
        "blobContainerName": "contosocontainer"
      }
    }
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_CreateOrUpdateForCustomTopic_StorageQueueDestination

Pedido de amostra

PUT https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1?api-version=2022-06-15

{
  "properties": {
    "destination": {
      "endpointType": "StorageQueue",
      "properties": {
        "resourceId": "/subscriptions/d33c5f7a-02ea-40f4-bf52-07f17e84d6a8/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg",
        "queueName": "queue1"
      }
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "deadLetterDestination": {
      "endpointType": "StorageBlob",
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg",
        "blobContainerName": "contosocontainer"
      }
    }
  }
}

Resposta da amostra

{
  "properties": {
    "destination": {
      "properties": {
        "resourceId": "/subscriptions/d33c5f7a-02ea-40f4-bf52-07f17e84d6a8/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg",
        "queueName": "queue1"
      },
      "endpointType": "StorageQueue"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1",
    "provisioningState": "Creating",
    "labels": null,
    "deadLetterDestination": {
      "endpointType": "StorageBlob",
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg",
        "blobContainerName": "contosocontainer"
      }
    }
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_CreateOrUpdateForCustomTopic_WebhookDestination

Pedido de amostra

PUT https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1?api-version=2022-06-15

{
  "properties": {
    "destination": {
      "endpointType": "WebHook",
      "properties": {
        "endpointUrl": "https://azurefunctionexample.azurewebsites.net/runtime/webhooks/EventGrid?functionName=EventGridTrigger1&code=PASSWORDCODE"
      }
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    }
  }
}

Resposta da amostra

{
  "properties": {
    "destination": {
      "properties": {
        "endpointBaseUrl": "https://azurefunctionexample.azurewebsites.net/runtime/webhooks/EventGrid"
      },
      "endpointType": "WebHook"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic1"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_CreateOrUpdateForResource

Pedido de amostra

PUT https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription10?api-version=2022-06-15

{
  "properties": {
    "destination": {
      "endpointType": "WebHook",
      "properties": {
        "endpointUrl": "https://requestb.in/15ksip71"
      }
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    }
  }
}

Resposta da amostra

{
  "properties": {
    "destination": {
      "properties": {
        "endpointBaseUrl": "https://requestb.in/15ksip71"
      },
      "endpointType": "WebHook"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "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/examplesubscription10",
  "name": "examplesubscription10",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_CreateOrUpdateForResourceGroup

Pedido de amostra

PUT https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription2?api-version=2022-06-15

{
  "properties": {
    "destination": {
      "endpointType": "WebHook",
      "properties": {
        "endpointUrl": "https://requestb.in/15ksip71"
      }
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    }
  }
}

Resposta da amostra

{
  "properties": {
    "destination": {
      "properties": {
        "endpointBaseUrl": "https://requestb.in/15ksip71"
      },
      "endpointType": "WebHook"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "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_CreateOrUpdateForSubscription

Pedido de amostra

PUT https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription3?api-version=2022-06-15

{
  "properties": {
    "destination": {
      "endpointType": "WebHook",
      "properties": {
        "endpointUrl": "https://requestb.in/15ksip71"
      }
    },
    "filter": {
      "isSubjectCaseSensitive": false
    }
  }
}

Resposta da amostra

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

Definições

Name Description
AzureFunctionEventSubscriptionDestination

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

BoolEqualsAdvancedFilter

Filtro Avançado boolEquals.

createdByType

O tipo de identidade que criou o recurso.

DeadLetterWithResourceIdentity

Informações sobre o destino deadletter com a identidade do recurso.

DeliveryWithResourceIdentity

Informações sobre a entrega de uma subscrição de evento com identidade de recurso.

DynamicDeliveryAttributeMapping

Detalhes de mapeamento de atributos de entrega dinâmica.

EventDeliverySchema

O esquema de entrega de eventos para a subscrição do evento.

EventHubEventSubscriptionDestination

Informações sobre o destino do hub de eventos para uma subscrição de eventos.

EventSubscription

Subscrição de Eventos

EventSubscriptionFilter

Filtrar para a Subscrição de Eventos.

EventSubscriptionIdentity

As informações de identidade com a subscrição do evento.

EventSubscriptionIdentityType

O tipo de identidade gerida utilizada. O tipo "SystemAssigned, UserAssigned" inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo utilizador. O tipo "Nenhum" removerá qualquer identidade.

EventSubscriptionProvisioningState

Estado de aprovisionamento da subscrição do evento.

HybridConnectionEventSubscriptionDestination

Informações sobre o destino HybridConnection de uma subscrição de evento.

IsNotNullAdvancedFilter

IsNotNull Advanced Filter.

IsNullOrUndefinedAdvancedFilter

Filtro Avançado IsNullOrUndefined.

NumberGreaterThanAdvancedFilter

NumberGreaterThan Advanced Filter.

NumberGreaterThanOrEqualsAdvancedFilter

Filtro Avançado NumberGreaterThanOrEquals.

NumberInAdvancedFilter

NumberIn Advanced Filter.

NumberInRangeAdvancedFilter

NumberInRange Advanced Filter.

NumberLessThanAdvancedFilter

NumberLessThan Advanced Filter.

NumberLessThanOrEqualsAdvancedFilter

NumberLessThanOrEquals Advanced Filter.

NumberNotInAdvancedFilter

Filtro Avançado NumberNotIn.

NumberNotInRangeAdvancedFilter

NumberNotInRange Advanced Filter.

RetryPolicy

Informações sobre a política de repetição de uma subscrição de evento.

ServiceBusQueueEventSubscriptionDestination

Informações sobre o destino do service bus para uma subscrição de evento.

ServiceBusTopicEventSubscriptionDestination

Informações sobre o destino do tópico do service bus para uma subscrição de evento.

StaticDeliveryAttributeMapping

Detalhes do mapeamento do atributo de entrega estática.

StorageBlobDeadLetterDestination

Informações sobre o destino da letra não entregue com base no blob de armazenamento.

StorageQueueEventSubscriptionDestination

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

StringBeginsWithAdvancedFilter

StringBeginsWith Advanced Filter.

StringContainsAdvancedFilter

StringContains Advanced Filter.

StringEndsWithAdvancedFilter

StringEndsWith Advanced Filter.

StringInAdvancedFilter

StringIn Advanced Filter.

StringNotBeginsWithAdvancedFilter

StringNotBeginsWith Advanced Filter.

StringNotContainsAdvancedFilter

StringNotContains Advanced Filter.

StringNotEndsWithAdvancedFilter

StringNotEndsWith Advanced Filter.

StringNotInAdvancedFilter

Filtro Avançado StringNotIn.

systemData

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

WebHookEventSubscriptionDestination

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

AzureFunctionEventSubscriptionDestination

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

Name Tipo Default value Description
endpointType string:

AzureFunction

Tipo do ponto final para o destino da subscrição de eventos.

properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

Detalhes do atributo de entrega.

properties.maxEventsPerBatch

integer

1

Número máximo de eventos por lote.

properties.preferredBatchSizeInKilobytes

integer

64

Tamanho preferencial do lote em Kilobytes.

properties.resourceId

string

O ID de Recurso do Azure que representa o ponto final do destino da Função do Azure de uma subscrição de evento.

BoolEqualsAdvancedFilter

Filtro Avançado boolEquals.

Name Tipo Description
key

string

O campo/propriedade no evento com base no qual pretende filtrar.

operatorType string:

BoolEquals

O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros.

value

boolean

O valor do filtro booleano.

createdByType

O tipo de identidade que criou o recurso.

Name Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

DeadLetterWithResourceIdentity

Informações sobre o destino deadletter com a identidade do recurso.

Name Tipo Description
deadLetterDestination DeadLetterDestination:

StorageBlobDeadLetterDestination

Informações sobre o destino onde os eventos têm de ser entregues para a subscrição do evento. Utiliza a configuração da identidade gerida no recurso principal (nomeadamente, tópico ou domínio) para adquirir os tokens de autenticação que estão a ser utilizados durante a entrega/letra não entregue.

identity

EventSubscriptionIdentity

A identidade a utilizar quando são apresentados eventos de letra não entregue.

DeliveryWithResourceIdentity

Informações sobre a entrega de uma subscrição de evento com identidade de recurso.

Name Tipo Description
destination EventSubscriptionDestination:

Informações sobre o destino onde os eventos têm de ser entregues para a subscrição do evento. Utiliza a identidade do Azure Event Grid para adquirir os tokens de autenticação que estão a ser utilizados durante a entrega/sem letras.

identity

EventSubscriptionIdentity

A identidade a utilizar ao entregar eventos.

DynamicDeliveryAttributeMapping

Detalhes de mapeamento de atributos de entrega dinâmica.

Name Tipo Description
name

string

Nome do atributo ou cabeçalho de entrega.

properties.sourceField

string

Caminho JSON no evento que contém o valor do atributo.

type string:

Dynamic

Tipo do atributo de entrega ou nome do cabeçalho.

EventDeliverySchema

O esquema de entrega de eventos para a subscrição do evento.

Name Tipo Description
CloudEventSchemaV1_0

string

CustomInputSchema

string

EventGridSchema

string

EventHubEventSubscriptionDestination

Informações sobre o destino do hub de eventos para uma subscrição de eventos.

Name Tipo Description
endpointType string:

EventHub

Tipo do ponto final para o destino da subscrição de eventos.

properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

Detalhes do atributo de entrega.

properties.resourceId

string

O ID de Recurso do Azure que representa o ponto final de um destino do Hub de Eventos de uma subscrição de evento.

EventSubscription

Subscrição de Eventos

Name Tipo Default value Description
id

string

Identificador completamente qualificado do recurso.

name

string

Nome do recurso.

properties.deadLetterDestination DeadLetterDestination:

StorageBlobDeadLetterDestination

O destino da letra não entregue da subscrição do evento. Qualquer evento que não possa ser entregue no destino do respetivo destino é enviado para o destino da letra não entregue. Utiliza a identidade do Azure Event Grid para adquirir os tokens de autenticação que estão a ser utilizados durante a entrega/sem letras.

properties.deadLetterWithResourceIdentity

DeadLetterWithResourceIdentity

O destino da letra não entregue da subscrição do evento. Qualquer evento que não possa ser entregue no destino do respetivo destino é enviado para o destino da letra não entregue. Utiliza a configuração da identidade gerida no recurso principal (nomeadamente, tópico ou domínio) para adquirir os tokens de autenticação que estão a ser utilizados durante a entrega/letra não entregue.

properties.deliveryWithResourceIdentity

DeliveryWithResourceIdentity

Informações sobre o destino onde os eventos têm de ser entregues para a subscrição do evento. Utiliza a configuração da identidade gerida no recurso principal (nomeadamente, tópico ou domínio) para adquirir os tokens de autenticação que estão a ser utilizados durante a entrega/letra não entregue.

properties.destination EventSubscriptionDestination:

Informações sobre o destino onde os eventos têm de ser entregues para a subscrição do evento. Utiliza a identidade do Azure Event Grid para adquirir os tokens de autenticação que estão a ser utilizados durante a entrega/sem letras.

properties.eventDeliverySchema

EventDeliverySchema

EventGridSchema

O esquema de entrega de eventos para a subscrição do evento.

properties.expirationTimeUtc

string

Tempo de expiração da subscrição do evento.

properties.filter

EventSubscriptionFilter

Informações sobre o filtro da subscrição do evento.

properties.labels

string[]

Lista de etiquetas definidas pelo utilizador.

properties.provisioningState

EventSubscriptionProvisioningState

Estado de aprovisionamento da subscrição do evento.

properties.retryPolicy

RetryPolicy

A política de repetição para eventos. Isto pode ser utilizado para configurar o número máximo de tentativas de entrega e tempo de transmissão em direto para eventos.

properties.topic

string

Nome do tópico da subscrição do evento.

systemData

systemData

Os metadados do sistema relacionados com o recurso da Subscrição de Eventos.

type

string

Tipo de recurso.

EventSubscriptionFilter

Filtrar para a Subscrição de Eventos.

Name Tipo Default value Description
advancedFilters AdvancedFilter[]:

Uma matriz de filtros avançados que são utilizados para filtrar subscrições de eventos.

enableAdvancedFilteringOnArrays

boolean

Permite que os filtros avançados sejam avaliados relativamente a uma matriz de valores em vez de esperar um valor singular.

includedEventTypes

string[]

Uma lista dos tipos de evento aplicáveis que têm de fazer parte da subscrição do evento. Se quiser subscrever todos os tipos de eventos predefinidos, defina IncludedEventTypes como nulo.

isSubjectCaseSensitive

boolean

False

Especifica se as propriedades SubjectBeginsWith e SubjectEndsWith do filtro devem ser comparadas de forma sensível a maiúsculas e minúsculas.

subjectBeginsWith

string

Uma cadeia opcional para filtrar eventos para uma subscrição de evento com base num prefixo de caminho de recurso. O formato deste procedimento depende do publicador dos eventos. Os carateres universais não são suportados neste caminho.

subjectEndsWith

string

Uma cadeia opcional para filtrar eventos para uma subscrição de evento com base num sufixo de caminho de recurso. Os carateres universais não são suportados neste caminho.

EventSubscriptionIdentity

As informações de identidade com a subscrição do evento.

Name Tipo Description
type

EventSubscriptionIdentityType

O tipo de identidade gerida utilizada. O tipo "SystemAssigned, UserAssigned" inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo utilizador. O tipo "Nenhum" removerá qualquer identidade.

userAssignedIdentity

string

A identidade de utilizador associada ao recurso.

EventSubscriptionIdentityType

O tipo de identidade gerida utilizada. O tipo "SystemAssigned, UserAssigned" inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo utilizador. O tipo "Nenhum" removerá qualquer identidade.

Name Tipo Description
SystemAssigned

string

UserAssigned

string

EventSubscriptionProvisioningState

Estado de aprovisionamento da subscrição do evento.

Name Tipo Description
AwaitingManualAction

string

Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

HybridConnectionEventSubscriptionDestination

Informações sobre o destino HybridConnection de uma subscrição de evento.

Name Tipo Description
endpointType string:

HybridConnection

Tipo do ponto final para o destino da subscrição de eventos.

properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

Detalhes do atributo de entrega.

properties.resourceId

string

O ID de Recurso do Azure de uma ligação híbrida que é o destino de uma subscrição de evento.

IsNotNullAdvancedFilter

IsNotNull Advanced Filter.

Name Tipo Description
key

string

O campo/propriedade no evento com base no qual pretende filtrar.

operatorType string:

IsNotNull

O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros.

IsNullOrUndefinedAdvancedFilter

Filtro Avançado IsNullOrUndefined.

Name Tipo Description
key

string

O campo/propriedade no evento com base no qual pretende filtrar.

operatorType string:

IsNullOrUndefined

O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros.

NumberGreaterThanAdvancedFilter

NumberGreaterThan Advanced Filter.

Name Tipo Description
key

string

O campo/propriedade no evento com base no qual pretende filtrar.

operatorType string:

NumberGreaterThan

O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros.

value

number

O valor do filtro.

NumberGreaterThanOrEqualsAdvancedFilter

Filtro Avançado NumberGreaterThanOrEquals.

Name Tipo Description
key

string

O campo/propriedade no evento com base no qual pretende filtrar.

operatorType string:

NumberGreaterThanOrEquals

O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros.

value

number

O valor do filtro.

NumberInAdvancedFilter

NumberIn Advanced Filter.

Name Tipo Description
key

string

O campo/propriedade no evento com base no qual pretende filtrar.

operatorType string:

NumberIn

O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros.

values

number[]

O conjunto de valores de filtro.

NumberInRangeAdvancedFilter

NumberInRange Advanced Filter.

Name Tipo Description
key

string

O campo/propriedade no evento com base no qual pretende filtrar.

operatorType string:

NumberInRange

O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros.

values

number[]

O conjunto de valores de filtro.

NumberLessThanAdvancedFilter

NumberLessThan Advanced Filter.

Name Tipo Description
key

string

O campo/propriedade no evento com base no qual pretende filtrar.

operatorType string:

NumberLessThan

O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros.

value

number

O valor do filtro.

NumberLessThanOrEqualsAdvancedFilter

NumberLessThanOrEquals Advanced Filter.

Name Tipo Description
key

string

O campo/propriedade no evento com base no qual pretende filtrar.

operatorType string:

NumberLessThanOrEquals

O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros.

value

number

O valor do filtro.

NumberNotInAdvancedFilter

Filtro Avançado NumberNotIn.

Name Tipo Description
key

string

O campo/propriedade no evento com base no qual pretende filtrar.

operatorType string:

NumberNotIn

O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros.

values

number[]

O conjunto de valores de filtro.

NumberNotInRangeAdvancedFilter

NumberNotInRange Advanced Filter.

Name Tipo Description
key

string

O campo/propriedade no evento com base no qual pretende filtrar.

operatorType string:

NumberNotInRange

O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros.

values

number[]

O conjunto de valores de filtro.

RetryPolicy

Informações sobre a política de repetição de uma subscrição de evento.

Name Tipo Default value Description
eventTimeToLiveInMinutes

integer

1440

Time To Live (em minutos) para eventos.

maxDeliveryAttempts

integer

30

Número máximo de tentativas de repetição de entrega para eventos.

ServiceBusQueueEventSubscriptionDestination

Informações sobre o destino do service bus para uma subscrição de evento.

Name Tipo Description
endpointType string:

ServiceBusQueue

Tipo do ponto final para o destino da subscrição de eventos.

properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

Detalhes do atributo de entrega.

properties.resourceId

string

O ID de Recurso do Azure que representa o ponto final do destino do Service Bus de uma subscrição de evento.

ServiceBusTopicEventSubscriptionDestination

Informações sobre o destino do tópico do service bus para uma subscrição de evento.

Name Tipo Description
endpointType string:

ServiceBusTopic

Tipo do ponto final para o destino da subscrição de eventos.

properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

Detalhes do atributo de entrega.

properties.resourceId

string

O ID de Recurso do Azure que representa o ponto final do destino do Tópico do Service Bus de uma subscrição de evento.

StaticDeliveryAttributeMapping

Detalhes do mapeamento do atributo de entrega estática.

Name Tipo Default value Description
name

string

Nome do atributo ou cabeçalho de entrega.

properties.isSecret

boolean

False

Sinalizador booleano para saber se o atributo contém informações confidenciais.

properties.value

string

Valor do atributo de entrega.

type string:

Static

Tipo do atributo de entrega ou nome do cabeçalho.

StorageBlobDeadLetterDestination

Informações sobre o destino da letra não entregue com base no blob de armazenamento.

Name Tipo Description
endpointType string:

StorageBlob

Tipo de ponto final para o destino da letra não entregue

properties.blobContainerName

string

O nome do contentor de blobs de armazenamento que é o destino dos eventos deadletter

properties.resourceId

string

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

StorageQueueEventSubscriptionDestination

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

Name Tipo Description
endpointType string:

StorageQueue

Tipo do ponto final para o destino da subscrição de eventos.

properties.queueMessageTimeToLiveInSeconds

integer

Tempo de espera da fila de armazenamento para viver em segundos.

properties.queueName

string

O nome da fila de Armazenamento numa conta de armazenamento que é o destino de uma subscrição de evento.

properties.resourceId

string

O ID de Recurso do Azure da conta de armazenamento que contém a fila que é o destino de uma subscrição de evento.

StringBeginsWithAdvancedFilter

StringBeginsWith Advanced Filter.

Name Tipo Description
key

string

O campo/propriedade no evento com base no qual pretende filtrar.

operatorType string:

StringBeginsWith

O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros.

values

string[]

O conjunto de valores de filtro.

StringContainsAdvancedFilter

StringContains Advanced Filter.

Name Tipo Description
key

string

O campo/propriedade no evento com base no qual pretende filtrar.

operatorType string:

StringContains

O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros.

values

string[]

O conjunto de valores de filtro.

StringEndsWithAdvancedFilter

StringEndsWith Advanced Filter.

Name Tipo Description
key

string

O campo/propriedade no evento com base no qual pretende filtrar.

operatorType string:

StringEndsWith

O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros.

values

string[]

O conjunto de valores de filtro.

StringInAdvancedFilter

StringIn Advanced Filter.

Name Tipo Description
key

string

O campo/propriedade no evento com base no qual pretende filtrar.

operatorType string:

StringIn

O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros.

values

string[]

O conjunto de valores de filtro.

StringNotBeginsWithAdvancedFilter

StringNotBeginsWith Advanced Filter.

Name Tipo Description
key

string

O campo/propriedade no evento com base no qual pretende filtrar.

operatorType string:

StringNotBeginsWith

O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros.

values

string[]

O conjunto de valores de filtro.

StringNotContainsAdvancedFilter

StringNotContains Advanced Filter.

Name Tipo Description
key

string

O campo/propriedade no evento com base no qual pretende filtrar.

operatorType string:

StringNotContains

O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros.

values

string[]

O conjunto de valores de filtro.

StringNotEndsWithAdvancedFilter

StringNotEndsWith Advanced Filter.

Name Tipo Description
key

string

O campo/propriedade no evento com base no qual pretende filtrar.

operatorType string:

StringNotEndsWith

O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros.

values

string[]

O conjunto de valores de filtro.

StringNotInAdvancedFilter

Filtro Avançado StringNotIn.

Name Tipo Description
key

string

O campo/propriedade no evento com base no qual pretende filtrar.

operatorType string:

StringNotIn

O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros.

values

string[]

O conjunto de valores de filtro.

systemData

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

Name Tipo Description
createdAt

string

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

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.

WebHookEventSubscriptionDestination

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

Name Tipo Default value Description
endpointType string:

WebHook

Tipo do ponto final para o destino da subscrição de eventos.

properties.azureActiveDirectoryApplicationIdOrUri

string

O ID ou o URI da Aplicação do Azure Active Directory para obter o token de acesso que será incluído como token de portador nos pedidos de entrega.

properties.azureActiveDirectoryTenantId

string

O ID de Inquilino do Azure Active Directory para obter o token de acesso que será incluído como o token de portador nos pedidos de entrega.

properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

Detalhes do atributo de entrega.

properties.endpointBaseUrl

string

O URL base que representa o ponto final do destino de uma subscrição de evento.

properties.endpointUrl

string

O URL que representa o ponto final do destino de uma subscrição de evento.

properties.maxEventsPerBatch

integer

1

Número máximo de eventos por lote.

properties.preferredBatchSizeInKilobytes

integer

64

Tamanho preferencial do lote em Kilobytes.