Partilhar via

Microsoft.EventGrid partnerNamespaces/channels 2024-12-15-preview

  • Artigo

Definição de recursos do bíceps

O tipo de recurso partnerNamespaces/channels pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log 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@2024-12-15-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    channelType: 'string'
    expirationTimeIfNotActivatedUtc: 'string'
    messageForActivation: 'string'
    partnerDestinationInfo: {
      azureSubscriptionId: 'string'
      endpointServiceContext: 'string'
      name: 'string'
      resourceGroupName: 'string'
      resourceMoveChangeHistory: [
        {
          azureSubscriptionId: 'string'
          changedTimeUtc: 'string'
          resourceGroupName: 'string'
        }
      ]
      endpointType: 'string'
      // For remaining properties, see PartnerDestinationInfo objects
    }
    partnerTopicInfo: {
      azureSubscriptionId: 'string'
      eventTypeInfo: {
        inlineEventTypes: {
          {customized property}: {
            dataSchemaUrl: 'string'
            description: 'string'
            displayName: 'string'
            documentationUrl: 'string'
          }
        }
        kind: 'string'
      }
      name: 'string'
      resourceGroupName: 'string'
      source: 'string'
    }
    provisioningState: 'string'
    readinessState: 'string'
  }
}

Objetos PartnerDestinationInfo

Defina a propriedade endpointType para especificar o tipo de objeto.

Para WebHook, use:

{
  endpointType: 'WebHook'
  properties: {
    clientAuthentication: {
      clientAuthenticationType: 'string'
      // For remaining properties, see PartnerClientAuthentication objects
    }
    endpointBaseUrl: 'string'
    endpointUrl: 'string'
  }
}

Objetos PartnerClientAuthentication

Defina a propriedade clientAuthenticationType para especificar o tipo de objeto.

Para AzureAD, use:

{
  clientAuthenticationType: 'AzureAD'
  properties: {
    azureActiveDirectoryApplicationIdOrUri: 'string'
    azureActiveDirectoryTenantId: 'string'
  }
}

Valores de propriedade

AzureADPartnerClientAuthentication

Designação Descrição Valor
clientAuthenticationType Tipo de autenticação do cliente 'AzureAD' (obrigatório)
propriedades Propriedades AzureAD ClientAuthentication AzureADPartnerClientAuthenticationProperties

AzureADPartnerClientAuthenticationProperties

Designação Descrição Valor
azureActiveDirectoryApplicationIdOrUri A ID do Aplicativo do Ative Directory do Azure ou URI para obter o token de acesso que será incluído como o token de portador nas solicitações de entrega. string
azureActiveDirectoryTenantId A ID do Locatário do Ative Directory do Azure para obter o token de acesso que será incluído como o token de portador nas solicitações de entrega. string

Propriedades do canal

Designação Descrição Valor
Tipo de canal O tipo do canal de evento que representa o fluxo de direção dos eventos. 'DestinoParceiro'
'ParceiroTópico'
expirationTimeIfNotActivatedUtc Tempo de expiração do canal. Se este temporizador expirar enquanto o tópico de parceiro correspondente nunca for ativado,
O canal e o tópico de parceiro correspondente são excluídos.		 string
messageForActivation Contexto ou mensagem útil que pode ser usada durante o processo de aprovação pelo assinante. string
parceiroDestinationInfo Essa propriedade deve ser preenchida quando channelType é PartnerDestination e representa informações sobre o recurso de destino do parceiro correspondente ao canal. PartnerDestinationInfo
parceiroTopicInfo Essa propriedade deve ser preenchida quando channelType é PartnerTopic e representa informações sobre o recurso de tópico de parceiro correspondente ao canal. PartnerTopicInfo
provisionamentoEstado Estado de provisionamento do canal. 'Cancelado'
'Criar'
'Eliminação'
'Falhou'
'IdleDueToMirroredPartnerDestinationDeletion'
'IdleDueToMirroredPartnerTopicDeletion'
'Conseguiu'
'Atualização'
prontidãoEstado O estado de prontidão do tópico de parceiro correspondente. 'Ativado'
'Nunca ativado'

EventTypeInfo

Designação Descrição Valor
inlineEventTypes Uma coleção de tipos de eventos embutidos para o recurso. As chaves de tipo de evento embutidas são do tipo string que representa o nome do evento.
Um exemplo de um nome de evento embutido válido é "Contoso.OrderCreated".
Os valores de tipo de evento embutido são do tipo InlineEventProperties e conterão informações adicionais para cada tipo de evento embutido.		 EventTypeInfoInlineEventTypes
tipo O tipo de tipo de evento usado. 'Em linha'

EventTypeInfoInlineEventTypes

Designação Descrição Valor

InlineEventProperties

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

Microsoft.EventGrid/partnerNamespaces/channels

Designação Descrição Valor
Designação O nome do recurso string (obrigatório)
pai No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai.

Para obter mais informações, consulte recurso filho fora do recurso pai.		 Nome simbólico para recurso do tipo: partnerNamespaces
propriedades Propriedades do canal. ChannelProperties

PartnerClientAuthentication

Designação Descrição Valor
clientAuthenticationType Defina como 'AzureAD' para o tipo AzureADPartnerClientAuthentication. 'AzureAD' (obrigatório)

PartnerDestinationInfo

Designação Descrição Valor
azureSubscriptionId ID de assinatura do Azure do assinante. O destino do parceiro associado ao canal será
criado sob esta assinatura do Azure.		 string
endpointServiceContext Contexto adicional do ponto de extremidade de destino do parceiro. string
endpointType Defina como 'WebHook' para digitar WebhookPartnerDestinationInfo. 'WebHook' (obrigatório)
Designação Nome do destino do parceiro associado ao canal. string
resourceGroupName Grupo de Recursos do Azure do assinante. O destino do parceiro associado ao canal será
criado sob este grupo de recursos.		 string
resourceMoveChangeHistory Histórico de alterações da movimentação do recurso. ResourceMoveChangeHistory []

ParceiroTopicInfo

Designação Descrição Valor
azureSubscriptionId ID de assinatura do Azure do assinante. O tópico do parceiro associado ao canal será
criado sob esta assinatura do Azure.		 string
eventTypeInfo Informações de tipo de evento para o tópico do parceiro. Esta informação é fornecida pelo editor e pode ser usada pelo
assinante para visualizar diferentes tipos de eventos que são publicados.		 EventTypeInfo
Designação Nome do tópico do parceiro associado ao canal. string
resourceGroupName Grupo de Recursos do Azure do assinante. O tópico do parceiro associado ao canal será
criado sob este grupo de recursos.		 string
fonte A informação de origem é fornecida pelo editor para determinar o âmbito ou contexto a partir do qual os eventos
são originários. Esta informação pode ser utilizada pelo assinante durante o processo de aprovação do
criou o tópico do parceiro.		 string

ResourceMoveChangeHistory

Designação Descrição Valor
azureSubscriptionId ID de assinatura do Azure do recurso. string
changedTimeUtc Carimbo de data/hora UTC de quando o recurso foi alterado. string
resourceGroupName Grupo de Recursos do Azure do recurso. string

WebhookPartnerDestinationInfo

Designação Descrição Valor
endpointType Tipo de ponto de extremidade para o destino do parceiro 'WebHook' (obrigatório)
propriedades Propriedades WebHook do destino do parceiro. WebhookPartnerDestinationProperties

WebhookPartnerDestinationProperties

Designação Descrição Valor
clientAuthentication Autenticação de cliente parceiro PartnerClientAuthentication
endpointBaseUrl A URL base que representa o ponto de extremidade do destino do parceiro. string
endpointUrl A URL que representa o ponto de extremidade do destino do parceiro. string

Definição de recurso de modelo ARM

O tipo de recurso partnerNamespaces/channels pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log 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": "2024-12-15-preview",
  "name": "string",
  "properties": {
    "channelType": "string",
    "expirationTimeIfNotActivatedUtc": "string",
    "messageForActivation": "string",
    "partnerDestinationInfo": {
      "azureSubscriptionId": "string",
      "endpointServiceContext": "string",
      "name": "string",
      "resourceGroupName": "string",
      "resourceMoveChangeHistory": [
        {
          "azureSubscriptionId": "string",
          "changedTimeUtc": "string",
          "resourceGroupName": "string"
        }
      ],
      "endpointType": "string"
      // For remaining properties, see PartnerDestinationInfo objects
    },
    "partnerTopicInfo": {
      "azureSubscriptionId": "string",
      "eventTypeInfo": {
        "inlineEventTypes": {
          "{customized property}": {
            "dataSchemaUrl": "string",
            "description": "string",
            "displayName": "string",
            "documentationUrl": "string"
          }
        },
        "kind": "string"
      },
      "name": "string",
      "resourceGroupName": "string",
      "source": "string"
    },
    "provisioningState": "string",
    "readinessState": "string"
  }
}

Objetos PartnerDestinationInfo

Defina a propriedade endpointType para especificar o tipo de objeto.

Para WebHook, use:

{
  "endpointType": "WebHook",
  "properties": {
    "clientAuthentication": {
      "clientAuthenticationType": "string"
      // For remaining properties, see PartnerClientAuthentication objects
    },
    "endpointBaseUrl": "string",
    "endpointUrl": "string"
  }
}

Objetos PartnerClientAuthentication

Defina a propriedade clientAuthenticationType para especificar o tipo de objeto.

Para AzureAD, use:

{
  "clientAuthenticationType": "AzureAD",
  "properties": {
    "azureActiveDirectoryApplicationIdOrUri": "string",
    "azureActiveDirectoryTenantId": "string"
  }
}

Valores de propriedade

AzureADPartnerClientAuthentication

Designação Descrição Valor
clientAuthenticationType Tipo de autenticação do cliente 'AzureAD' (obrigatório)
propriedades Propriedades AzureAD ClientAuthentication AzureADPartnerClientAuthenticationProperties

AzureADPartnerClientAuthenticationProperties

Designação Descrição Valor
azureActiveDirectoryApplicationIdOrUri A ID do Aplicativo do Ative Directory do Azure ou URI para obter o token de acesso que será incluído como o token de portador nas solicitações de entrega. string
azureActiveDirectoryTenantId A ID do Locatário do Ative Directory do Azure para obter o token de acesso que será incluído como o token de portador nas solicitações de entrega. string

Propriedades do canal

Designação Descrição Valor
Tipo de canal O tipo do canal de evento que representa o fluxo de direção dos eventos. 'DestinoParceiro'
'ParceiroTópico'
expirationTimeIfNotActivatedUtc Tempo de expiração do canal. Se este temporizador expirar enquanto o tópico de parceiro correspondente nunca for ativado,
O canal e o tópico de parceiro correspondente são excluídos.		 string
messageForActivation Contexto ou mensagem útil que pode ser usada durante o processo de aprovação pelo assinante. string
parceiroDestinationInfo Essa propriedade deve ser preenchida quando channelType é PartnerDestination e representa informações sobre o recurso de destino do parceiro correspondente ao canal. PartnerDestinationInfo
parceiroTopicInfo Essa propriedade deve ser preenchida quando channelType é PartnerTopic e representa informações sobre o recurso de tópico de parceiro correspondente ao canal. PartnerTopicInfo
provisionamentoEstado Estado de provisionamento do canal. 'Cancelado'
'Criar'
'Eliminação'
'Falhou'
'IdleDueToMirroredPartnerDestinationDeletion'
'IdleDueToMirroredPartnerTopicDeletion'
'Conseguiu'
'Atualização'
prontidãoEstado O estado de prontidão do tópico de parceiro correspondente. 'Ativado'
'Nunca ativado'

EventTypeInfo

Designação Descrição Valor
inlineEventTypes Uma coleção de tipos de eventos embutidos para o recurso. As chaves de tipo de evento embutidas são do tipo string que representa o nome do evento.
Um exemplo de um nome de evento embutido válido é "Contoso.OrderCreated".
Os valores de tipo de evento embutido são do tipo InlineEventProperties e conterão informações adicionais para cada tipo de evento embutido.		 EventTypeInfoInlineEventTypes
tipo O tipo de tipo de evento usado. 'Em linha'

EventTypeInfoInlineEventTypes

Designação Descrição Valor

InlineEventProperties

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

Microsoft.EventGrid/partnerNamespaces/channels

Designação Descrição Valor
apiVersion A versão api '2024-12-15-pré-visualização'
Designação O nome do recurso string (obrigatório)
propriedades Propriedades do canal. ChannelProperties
tipo O tipo de recurso 'Microsoft.EventGrid/partnerNamespaces/channels'

PartnerClientAuthentication

Designação Descrição Valor
clientAuthenticationType Defina como 'AzureAD' para o tipo AzureADPartnerClientAuthentication. 'AzureAD' (obrigatório)

PartnerDestinationInfo

Designação Descrição Valor
azureSubscriptionId ID de assinatura do Azure do assinante. O destino do parceiro associado ao canal será
criado sob esta assinatura do Azure.		 string
endpointServiceContext Contexto adicional do ponto de extremidade de destino do parceiro. string
endpointType Defina como 'WebHook' para digitar WebhookPartnerDestinationInfo. 'WebHook' (obrigatório)
Designação Nome do destino do parceiro associado ao canal. string
resourceGroupName Grupo de Recursos do Azure do assinante. O destino do parceiro associado ao canal será
criado sob este grupo de recursos.		 string
resourceMoveChangeHistory Histórico de alterações da movimentação do recurso. ResourceMoveChangeHistory []

ParceiroTopicInfo

Designação Descrição Valor
azureSubscriptionId ID de assinatura do Azure do assinante. O tópico do parceiro associado ao canal será
criado sob esta assinatura do Azure.		 string
eventTypeInfo Informações de tipo de evento para o tópico do parceiro. Esta informação é fornecida pelo editor e pode ser usada pelo
assinante para visualizar diferentes tipos de eventos que são publicados.		 EventTypeInfo
Designação Nome do tópico do parceiro associado ao canal. string
resourceGroupName Grupo de Recursos do Azure do assinante. O tópico do parceiro associado ao canal será
criado sob este grupo de recursos.		 string
fonte A informação de origem é fornecida pelo editor para determinar o âmbito ou contexto a partir do qual os eventos
são originários. Esta informação pode ser utilizada pelo assinante durante o processo de aprovação do
criou o tópico do parceiro.		 string

ResourceMoveChangeHistory

Designação Descrição Valor
azureSubscriptionId ID de assinatura do Azure do recurso. string
changedTimeUtc Carimbo de data/hora UTC de quando o recurso foi alterado. string
resourceGroupName Grupo de Recursos do Azure do recurso. string

WebhookPartnerDestinationInfo

Designação Descrição Valor
endpointType Tipo de ponto de extremidade para o destino do parceiro 'WebHook' (obrigatório)
propriedades Propriedades WebHook do destino do parceiro. WebhookPartnerDestinationProperties

WebhookPartnerDestinationProperties

Designação Descrição Valor
clientAuthentication Autenticação de cliente parceiro PartnerClientAuthentication
endpointBaseUrl A URL base que representa o ponto de extremidade do destino do parceiro. string
endpointUrl A URL que representa o ponto de extremidade do destino do parceiro. string

Definição de recursos Terraform (provedor AzAPI)

O tipo de recurso partnerNamespaces/channels pode ser implantado com operações direcionadas:

  • Grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log 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@2024-12-15-preview"
  name = "string"
  body = jsonencode({
    properties = {
      channelType = "string"
      expirationTimeIfNotActivatedUtc = "string"
      messageForActivation = "string"
      partnerDestinationInfo = {
        azureSubscriptionId = "string"
        endpointServiceContext = "string"
        name = "string"
        resourceGroupName = "string"
        resourceMoveChangeHistory = [
          {
            azureSubscriptionId = "string"
            changedTimeUtc = "string"
            resourceGroupName = "string"
          }
        ]
        endpointType = "string"
        // For remaining properties, see PartnerDestinationInfo objects
      }
      partnerTopicInfo = {
        azureSubscriptionId = "string"
        eventTypeInfo = {
          inlineEventTypes = {
            {customized property} = {
              dataSchemaUrl = "string"
              description = "string"
              displayName = "string"
              documentationUrl = "string"
            }
          }
          kind = "string"
        }
        name = "string"
        resourceGroupName = "string"
        source = "string"
      }
      provisioningState = "string"
      readinessState = "string"
    }
  })
}

Objetos PartnerDestinationInfo

Defina a propriedade endpointType para especificar o tipo de objeto.

Para WebHook, use:

{
  endpointType = "WebHook"
  properties = {
    clientAuthentication = {
      clientAuthenticationType = "string"
      // For remaining properties, see PartnerClientAuthentication objects
    }
    endpointBaseUrl = "string"
    endpointUrl = "string"
  }
}

Objetos PartnerClientAuthentication

Defina a propriedade clientAuthenticationType para especificar o tipo de objeto.

Para AzureAD, use:

{
  clientAuthenticationType = "AzureAD"
  properties = {
    azureActiveDirectoryApplicationIdOrUri = "string"
    azureActiveDirectoryTenantId = "string"
  }
}

Valores de propriedade

AzureADPartnerClientAuthentication

Designação Descrição Valor
clientAuthenticationType Tipo de autenticação do cliente 'AzureAD' (obrigatório)
propriedades Propriedades AzureAD ClientAuthentication AzureADPartnerClientAuthenticationProperties

AzureADPartnerClientAuthenticationProperties

Designação Descrição Valor
azureActiveDirectoryApplicationIdOrUri A ID do Aplicativo do Ative Directory do Azure ou URI para obter o token de acesso que será incluído como o token de portador nas solicitações de entrega. string
azureActiveDirectoryTenantId A ID do Locatário do Ative Directory do Azure para obter o token de acesso que será incluído como o token de portador nas solicitações de entrega. string

Propriedades do canal

Designação Descrição Valor
Tipo de canal O tipo do canal de evento que representa o fluxo de direção dos eventos. 'DestinoParceiro'
'ParceiroTópico'
expirationTimeIfNotActivatedUtc Tempo de expiração do canal. Se este temporizador expirar enquanto o tópico de parceiro correspondente nunca for ativado,
O canal e o tópico de parceiro correspondente são excluídos.		 string
messageForActivation Contexto ou mensagem útil que pode ser usada durante o processo de aprovação pelo assinante. string
parceiroDestinationInfo Essa propriedade deve ser preenchida quando channelType é PartnerDestination e representa informações sobre o recurso de destino do parceiro correspondente ao canal. PartnerDestinationInfo
parceiroTopicInfo Essa propriedade deve ser preenchida quando channelType é PartnerTopic e representa informações sobre o recurso de tópico de parceiro correspondente ao canal. PartnerTopicInfo
provisionamentoEstado Estado de provisionamento do canal. 'Cancelado'
'Criar'
'Eliminação'
'Falhou'
'IdleDueToMirroredPartnerDestinationDeletion'
'IdleDueToMirroredPartnerTopicDeletion'
'Conseguiu'
'Atualização'
prontidãoEstado O estado de prontidão do tópico de parceiro correspondente. 'Ativado'
'Nunca ativado'

EventTypeInfo

Designação Descrição Valor
inlineEventTypes Uma coleção de tipos de eventos embutidos para o recurso. As chaves de tipo de evento embutidas são do tipo string que representa o nome do evento.
Um exemplo de um nome de evento embutido válido é "Contoso.OrderCreated".
Os valores de tipo de evento embutido são do tipo InlineEventProperties e conterão informações adicionais para cada tipo de evento embutido.		 EventTypeInfoInlineEventTypes
tipo O tipo de tipo de evento usado. 'Em linha'

EventTypeInfoInlineEventTypes

Designação Descrição Valor

InlineEventProperties

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

Microsoft.EventGrid/partnerNamespaces/channels

Designação Descrição Valor
Designação O nome do recurso string (obrigatório)
parent_id A ID do recurso que é o pai para este recurso. ID para recurso do tipo: partnerNamespaces
propriedades Propriedades do canal. ChannelProperties
tipo O tipo de recurso "Microsoft.EventGrid/partnerNamespaces/channels@2024-12-15-preview"

PartnerClientAuthentication

Designação Descrição Valor
clientAuthenticationType Defina como 'AzureAD' para o tipo AzureADPartnerClientAuthentication. 'AzureAD' (obrigatório)

PartnerDestinationInfo

Designação Descrição Valor
azureSubscriptionId ID de assinatura do Azure do assinante. O destino do parceiro associado ao canal será
criado sob esta assinatura do Azure.		 string
endpointServiceContext Contexto adicional do ponto de extremidade de destino do parceiro. string
endpointType Defina como 'WebHook' para digitar WebhookPartnerDestinationInfo. 'WebHook' (obrigatório)
Designação Nome do destino do parceiro associado ao canal. string
resourceGroupName Grupo de Recursos do Azure do assinante. O destino do parceiro associado ao canal será
criado sob este grupo de recursos.		 string
resourceMoveChangeHistory Histórico de alterações da movimentação do recurso. ResourceMoveChangeHistory []

ParceiroTopicInfo

Designação Descrição Valor
azureSubscriptionId ID de assinatura do Azure do assinante. O tópico do parceiro associado ao canal será
criado sob esta assinatura do Azure.		 string
eventTypeInfo Informações de tipo de evento para o tópico do parceiro. Esta informação é fornecida pelo editor e pode ser usada pelo
assinante para visualizar diferentes tipos de eventos que são publicados.		 EventTypeInfo
Designação Nome do tópico do parceiro associado ao canal. string
resourceGroupName Grupo de Recursos do Azure do assinante. O tópico do parceiro associado ao canal será
criado sob este grupo de recursos.		 string
fonte A informação de origem é fornecida pelo editor para determinar o âmbito ou contexto a partir do qual os eventos
são originários. Esta informação pode ser utilizada pelo assinante durante o processo de aprovação do
criou o tópico do parceiro.		 string

ResourceMoveChangeHistory

Designação Descrição Valor
azureSubscriptionId ID de assinatura do Azure do recurso. string
changedTimeUtc Carimbo de data/hora UTC de quando o recurso foi alterado. string
resourceGroupName Grupo de Recursos do Azure do recurso. string

WebhookPartnerDestinationInfo

Designação Descrição Valor
endpointType Tipo de ponto de extremidade para o destino do parceiro 'WebHook' (obrigatório)
propriedades Propriedades WebHook do destino do parceiro. WebhookPartnerDestinationProperties

WebhookPartnerDestinationProperties

Designação Descrição Valor
clientAuthentication Autenticação de cliente parceiro PartnerClientAuthentication
endpointBaseUrl A URL base que representa o ponto de extremidade do destino do parceiro. string
endpointUrl A URL que representa o ponto de extremidade do destino do parceiro. string