Partilhar via

Microsoft.EventGrid partnerNamespaces/channels 2022-06-15

  • Artigo

Definição de recurso do Bicep

O tipo de recurso partnerNamespaces/channels pode ser implementado com operações que visam:

Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo de alterações.

Formato do recurso

Para criar um recurso Microsoft.EventGrid/partnerNamespaces/channels, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.EventGrid/partnerNamespaces/channels@2022-06-15' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    channelType: 'PartnerTopic'
    expirationTimeIfNotActivatedUtc: 'string'
    messageForActivation: 'string'
    partnerTopicInfo: {
      azureSubscriptionId: 'string'
      eventTypeInfo: {
        inlineEventTypes: {
          {customized property}: {
            dataSchemaUrl: 'string'
            description: 'string'
            displayName: 'string'
            documentationUrl: 'string'
          }
        }
        kind: 'Inline'
      }
      name: 'string'
      resourceGroupName: 'string'
      source: 'string'
    }
    provisioningState: 'string'
    readinessState: 'string'
  }
}

Valores de propriedade

partnerNamespaces/canais

Nome Descrição Valor
name O nome do recurso

Veja como definir nomes e tipos para recursos subordinados no Bicep.		 cadeia (obrigatório)
principal No Bicep, pode especificar o recurso principal de um recurso subordinado. Só tem de adicionar esta propriedade quando o recurso subordinado for declarado fora do recurso principal.

Para obter mais informações, veja Recurso subordinado fora do recurso principal.		 Nome simbólico para recurso do tipo: partnerNamespaces
propriedades Propriedades do Canal. ChannelProperties

ChannelProperties

Nome Descrição Valor
channelType O tipo do canal de eventos que representa o fluxo de direção dos eventos. "PartnerTopic"
expirationTimeIfNotActivatedUtc Hora de expiração do canal. Se este temporizador expirar enquanto o tópico de parceiro correspondente nunca estiver ativado,
o canal e o tópico de parceiro correspondente são eliminados.		 string
messageForActivation Contexto ou mensagem útil que pode ser utilizada durante o processo de aprovação pelo subscritor. string
partnerTopicInfo Esta propriedade deve ser preenchida quando channelType é PartnerTopic e representa informações sobre o recurso do tópico de parceiro correspondente ao canal. PartnerTopicInfo
provisioningState Estado de aprovisionamento do canal. "Cancelado"
"A criar"
"A eliminar"
"Com falhas"
"IdleDueToMirroredPartnerTopicDeletion"
"Com êxito"
"A atualizar"
readinessState O estado de preparação do tópico de parceiro correspondente. "Ativado"
"NeverActivated"

PartnerTopicInfo

Nome Descrição Valor
azureSubscriptionId ID da subscrição do Azure do subscritor. O tópico de parceiro associado ao canal será
criada nesta subscrição do Azure.		 string
eventTypeInfo Informações de Tipo de Evento para o tópico de parceiro. Estas informações são fornecidas pelo publicador e podem ser utilizadas pelo
subscritor para ver diferentes tipos de eventos que são publicados.		 EventTypeInfo
name Nome do tópico de parceiro associado ao canal. string
resourceGroupName Grupo de Recursos do Azure do subscritor. O tópico de parceiro associado ao canal será
criado neste grupo de recursos.		 string
source As informações de origem são fornecidas pelo publicador para determinar o âmbito ou o contexto a partir do qual os eventos
são originárias. Estas informações podem ser utilizadas pelo subscritor durante o processo de aprovação do
tópico de parceiro criado.
 string

EventTypeInfo

Nome Descrição Valor
inlineEventTypes Uma coleção de tipos de eventos inline para o recurso. As chaves de tipo de evento inline são do tipo cadeia que representa o nome do evento.
Um exemplo de um nome de evento inline válido é "Contoso.OrderCreated".
Os valores do tipo de evento inline são do tipo InlineEventProperties e irão conter informações adicionais para cada tipo de evento inline.		 EventTypeInfoInlineEventTypes
tipo O tipo de evento utilizado. "Inline"

EventTypeInfoInlineEventTypes

Nome Descrição Valor
{customized property} InlineEventProperties

InlineEventProperties

Nome Descrição Valor
dataSchemaUrl O dataSchemaUrl para o evento inline. string
descrição A descrição do evento inline. string
displayName O displayName para o evento inline. string
documentationUrl A documentaçãoUrl para o evento inline. string

Definição de recurso de modelo do ARM

O tipo de recurso partnerNamespaces/channels pode ser implementado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, veja registo de alterações.

Formato do recurso

Para criar um recurso Microsoft.EventGrid/partnerNamespaces/channels, adicione o seguinte JSON ao seu modelo.

{
  "type": "Microsoft.EventGrid/partnerNamespaces/channels",
  "apiVersion": "2022-06-15",
  "name": "string",
  "properties": {
    "channelType": "PartnerTopic",
    "expirationTimeIfNotActivatedUtc": "string",
    "messageForActivation": "string",
    "partnerTopicInfo": {
      "azureSubscriptionId": "string",
      "eventTypeInfo": {
        "inlineEventTypes": {
          "{customized property}": {
            "dataSchemaUrl": "string",
            "description": "string",
            "displayName": "string",
            "documentationUrl": "string"
          }
        },
        "kind": "Inline"
      },
      "name": "string",
      "resourceGroupName": "string",
      "source": "string"
    },
    "provisioningState": "string",
    "readinessState": "string"
  }
}

Valores de propriedade

partnerNamespaces/channels

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.EventGrid/partnerNamespaces/channels"
apiVersion A versão da API de recursos '2022-06-15'
name O nome do recurso

Veja como definir nomes e tipos para recursos subordinados em modelos do ARM JSON.		 cadeia (obrigatório)
propriedades Propriedades do Canal. ChannelProperties

ChannelProperties

Nome Descrição Valor
channelType O tipo do canal de eventos que representa o fluxo de direção dos eventos. "PartnerTopic"
expirationTimeIfNotActivatedUtc Tempo de expiração do canal. Se este temporizador expirar enquanto o tópico de parceiro correspondente nunca estiver ativado,
o canal e o tópico de parceiro correspondente são eliminados.		 string
messageForActivation Mensagem de contexto ou útil que pode ser utilizada durante o processo de aprovação pelo subscritor. string
partnerTopicInfo Esta propriedade deve ser preenchida quando channelType é PartnerTopic e representa informações sobre o recurso do tópico de parceiro correspondente ao canal. PartnerTopicInfo
provisioningState Estado de aprovisionamento do canal. "Cancelado"
"A criar"
"A eliminar"
"Falha"
"IdleDueToMirroredPartnerTopicDeletion"
"Bem-sucedido"
"A atualizar"
readinessState O estado de preparação do tópico de parceiro correspondente. "Ativado"
"Nunca Ativado"

PartnerTopicInfo

Nome Descrição Valor
azureSubscriptionId ID da subscrição do Azure do subscritor. O tópico de parceiro associado ao canal será
criada nesta subscrição do Azure.		 string
eventTypeInfo Informações do Tipo de Evento para o tópico de parceiro. Estas informações são fornecidas pelo publicador e podem ser utilizadas pelo
subscritor para ver diferentes tipos de eventos que são publicados.		 EventTypeInfo
name Nome do tópico de parceiro associado ao canal. string
resourceGroupName Grupo de Recursos do Azure do subscritor. O tópico de parceiro associado ao canal será
criado neste grupo de recursos.		 string
source As informações de origem são fornecidas pelo publicador para determinar o âmbito ou o contexto a partir do qual os eventos
são originárias. Estas informações podem ser utilizadas pelo subscritor durante o processo de aprovação do
tópico de parceiro criado.
 string

EventTypeInfo

Nome Descrição Valor
inlineEventTypes Uma coleção de tipos de eventos inline para o recurso. As chaves de tipo de evento inline são do tipo cadeia que representa o nome do evento.
Um exemplo de um nome de evento inline válido é "Contoso.OrderCreated".
Os valores do tipo de evento inline são do tipo InlineEventProperties e irão conter informações adicionais para cada tipo de evento inline.		 EventTypeInfoInlineEventTypes
tipo O tipo de evento utilizado. "Inline"

EventTypeInfoInlineEventTypes

Nome Descrição Valor
{customized property} InlineEventProperties

InlineEventProperties

Nome Descrição Valor
dataSchemaUrl O dataSchemaUrl para o evento inline. string
descrição A descrição do evento inline. string
displayName O displayName para o evento inline. string
documentationUrl A documentationUrl para o evento inline. string

Definição de recurso terraform (fornecedor AzAPI)

O tipo de recurso partnerNamespaces/channels pode ser implementado com operações que visam:

  • Grupos de recursos

Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo de alterações.

Formato do recurso

Para criar um recurso Microsoft.EventGrid/partnerNamespaces/channels, adicione o seguinte Terraform ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/partnerNamespaces/channels@2022-06-15"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      channelType = "PartnerTopic"
      expirationTimeIfNotActivatedUtc = "string"
      messageForActivation = "string"
      partnerTopicInfo = {
        azureSubscriptionId = "string"
        eventTypeInfo = {
          inlineEventTypes = {
            {customized property} = {
              dataSchemaUrl = "string"
              description = "string"
              displayName = "string"
              documentationUrl = "string"
            }
          }
          kind = "Inline"
        }
        name = "string"
        resourceGroupName = "string"
        source = "string"
      }
      provisioningState = "string"
      readinessState = "string"
    }
  })
}

Valores de propriedade

partnerNamespaces/canais

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.EventGrid/partnerNamespaces/channels@2022-06-15"
name O nome do recurso cadeia (obrigatório)
parent_id O ID do recurso que é o principal para este recurso. ID do recurso do tipo: partnerNamespaces
propriedades Propriedades do Canal. ChannelProperties

ChannelProperties

Nome Descrição Valor
channelType O tipo do canal de eventos que representa o fluxo de direção dos eventos. "PartnerTopic"
expirationTimeIfNotActivatedUtc Hora de expiração do canal. Se este temporizador expirar enquanto o tópico de parceiro correspondente nunca estiver ativado,
o canal e o tópico de parceiro correspondente são eliminados.		 string
messageForActivation Contexto ou mensagem útil que pode ser utilizada durante o processo de aprovação pelo subscritor. string
partnerTopicInfo Esta propriedade deve ser preenchida quando channelType é PartnerTopic e representa informações sobre o recurso do tópico de parceiro correspondente ao canal. PartnerTopicInfo
provisioningState Estado de aprovisionamento do canal. "Cancelado"
"A criar"
"A eliminar"
"Falhou"
"IdleDueToMirroredPartnerTopicDeletion"
"Com êxito"
"A atualizar"
readinessState O estado de preparação do tópico de parceiro correspondente. "Ativado"
"NeverActivated"

PartnerTopicInfo

Nome Descrição Valor
azureSubscriptionId ID da subscrição do Azure do subscritor. O tópico de parceiro associado ao canal será
criada nesta subscrição do Azure.		 string
eventTypeInfo Informações do Tipo de Evento para o tópico de parceiro. Estas informações são fornecidas pelo publicador e podem ser utilizadas pelo
subscritor para ver diferentes tipos de eventos que são publicados.		 EventTypeInfo
name Nome do tópico de parceiro associado ao canal. string
resourceGroupName Grupo de Recursos do Azure do subscritor. O tópico de parceiro associado ao canal será
criado neste grupo de recursos.		 string
source As informações de origem são fornecidas pelo publicador para determinar o âmbito ou o contexto a partir do qual os eventos
são originárias. Estas informações podem ser utilizadas pelo subscritor durante o processo de aprovação do
tópico de parceiro criado.
 string

EventTypeInfo

Nome Descrição Valor
inlineEventTypes Uma coleção de tipos de eventos inline para o recurso. As chaves do tipo de evento inline são do tipo cadeia que representa o nome do evento.
Um exemplo de um nome de evento inline válido é "Contoso.OrderCreated".
Os valores do tipo de evento inline são do tipo InlineEventProperties e conterão informações adicionais para cada tipo de evento inline.		 EventTypeInfoInlineEventTypes
tipo O tipo de evento utilizado. "Inline"

EventTypeInfoInlineEventTypes

Nome Descrição Valor
{customized property} InlineEventProperties

InlineEventProperties

Nome Descrição Valor
dataSchemaUrl O dataSchemaUrl para o evento inline. string
descrição A descrição do evento inline. string
displayName O displayName para o evento inline. string
documentationUrl A documentaçãoUrl para o evento inline. string