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

Artigo
12/20/2024

Definição de recurso do Bicep

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

Grupos de recursos - Consulte comandos de implantação do grupo de recursos

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

Formato de 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 do AzureAD, use:

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

Valores de propriedade

AzureADPartnerClientAuthentication

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

AzureADPartnerClientAuthenticationProperties

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

ChannelProperties

Nome	Descrição	Valor
channelType	O tipo do canal de eventos que representa o fluxo de direção dos eventos.	'PartnerDestination' 'PartnerTopic'
expirationTimeIfNotActivatedUtc	Hora de expiração do canal. Se esse temporizador expirar enquanto o tópico do parceiro correspondente nunca for ativado, o canal e o tópico do parceiro correspondente são excluídos.	corda
messageForActivation	Contexto ou mensagem útil que pode ser usada durante o processo de aprovação pelo assinante.	corda
partnerDestinationInfo	Essa propriedade deve ser preenchida quando channelType for PartnerDestination e representar informações sobre o recurso de destino do parceiro correspondente ao canal.	PartnerDestinationInfo
partnerTopicInfo	Essa propriedade deve ser preenchida quando channelType for PartnerTopic e representar informações sobre o recurso de tópico do parceiro correspondente ao canal.	PartnerTopicInfo
provisioningState	Estado de provisionamento do canal.	'Cancelado' 'Criando' 'Excluindo' 'Falha' 'IdleDueToMirroredPartnerDestinationDeletion' 'IdleDueToMirroredPartnerTopicDeletion' 'Bem-sucedido' 'Atualizando'
readinessState	O estado de preparação do tópico de parceiro correspondente.	'Ativado' 'NeverActivated'

EventTypeInfo

Nome	Descrição	Valor
inlineEventTypes	Uma coleção de tipos de eventos embutidos para o recurso. As chaves de tipo de evento embutidas são de cadeia de caracteres de tipo 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 evento usado.	'Embutido'

EventTypeInfoInlineEventTypes

Nome	Descrição	Valor

InlineEventProperties

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