Compartir a través de


Microsoft.EventGrid partnerNamespaces/channels

Definición de recursos de Bicep

El tipo de recurso partnerNamespaces/channels se puede implementar con operaciones que tienen como destino:

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.EventGrid/partnerNamespaces/channels, agregue el siguiente bicep a la plantilla.

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 PartnerClientAuthentication

Establezca la propiedad clientAuthenticationType para especificar el tipo de objeto.

Para azureAD, use:

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

Objetos PartnerDestinationInfo

Establezca la propiedad endpointType para especificar el tipo de objeto.

Para webHook, use:

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

Valores de propiedad

AzureADPartnerClientAuthentication

Nombre Descripción Valor
clientAuthenticationType Tipo de autenticación de cliente "AzureAD" (obligatorio)
Propiedades Propiedades clientAuthentication de AzureAD azureADPartnerClientAuthenticationProperties

AzureADPartnerClientAuthenticationProperties

Nombre Descripción Valor
azureActiveDirectoryApplicationIdOrUri Identificador de aplicación o URI de Azure Active Directory para obtener el token de acceso que se incluirá como token de portador en las solicitudes de entrega. cuerda
azureActiveDirectoryTenantId Identificador de inquilino de Azure Active Directory para obtener el token de acceso que se incluirá como token de portador en las solicitudes de entrega. cuerda

ChannelProperties

Nombre Descripción Valor
channelType Tipo del canal de eventos que representa el flujo de dirección de los eventos. 'PartnerDestination'
'PartnerTopic'
expirationTimeIfNotActivatedUtc Hora de expiración del canal. Si este temporizador expira mientras nunca se activa el tema del asociado correspondiente,
Se eliminan el canal y el tema de asociado correspondiente.
cuerda
messageForActivation Contexto o mensaje útil que el suscriptor puede usar durante el proceso de aprobación. cuerda
partnerDestinationInfo Esta propiedad debe rellenarse cuando channelType es PartnerDestination y representa información sobre el recurso de destino del asociado correspondiente al canal. PartnerDestinationInfo
partnerTopicInfo Esta propiedad debe rellenarse cuando channelType es PartnerTopic y representa información sobre el recurso del tema del asociado correspondiente al canal. partnerTopicInfo
provisioningState Estado de aprovisionamiento del canal. 'Cancelado'
'Crear'
"Eliminar"
'Error'
'IdleDueToMirroredPartnerDestinationDeletion'
'IdleDueToMirroredPartnerTopicDeletion'
"Correcto"
"Actualización"
ReadinessState Estado de preparación del tema de asociado correspondiente. "Activado"
'NeverActivated'

EventTypeInfo

Nombre Descripción Valor
inlineEventTypes Colección de tipos de eventos insertados para el recurso. Las claves de tipo de evento insertadas son de tipo cadena que representa el nombre del evento.
Un ejemplo de un nombre de evento insertado válido es "Contoso.OrderCreated".
Los valores de tipo de evento insertado son de tipo InlineEventProperties y contendrán información adicional para cada tipo de evento insertado.
EventTypeInfoInlineEventTypes
amable Tipo de evento usado. 'Inline'

EventTypeInfoInlineEventTypes

Nombre Descripción Valor

InlineEventProperties

Nombre Descripción Valor
dataSchemaUrl DataSchemaUrl para el evento insertado. cuerda
descripción Descripción del evento insertado. cuerda
displayName DisplayName para el evento insertado. cuerda
documentationUrl DocumentationUrl para el evento insertado. cuerda

Microsoft.EventGrid/partnerNamespaces/channels

Nombre Descripción Valor
nombre El nombre del recurso string (obligatorio)
padre En Bicep, puede especificar el recurso primario para un recurso secundario. Solo tiene que agregar esta propiedad cuando el recurso secundario se declara fuera del recurso primario.

Para obtener más información, consulte recurso secundario fuera del recurso primario.
Nombre simbólico del recurso de tipo: partnerNamespaces
Propiedades Propiedades del canal. ChannelProperties

PartnerClientAuthentication

Nombre Descripción Valor
clientAuthenticationType Establezca en "AzureAD" para el tipo AzureADPartnerClientAuthentication. "AzureAD" (obligatorio)

PartnerDestinationInfo

Nombre Descripción Valor
azureSubscriptionId Identificador de suscripción de Azure del suscriptor. El destino del asociado asociado al canal será
creado en esta suscripción de Azure.
cuerda
endpointServiceContext Contexto adicional del punto de conexión de destino del asociado. cuerda
endpointType Establezca en "WebHook" para el tipo WebhookPartnerDestinationInfo. "WebHook" (obligatorio)
nombre Nombre del destino del asociado asociado asociado al canal. cuerda
resourceGroupName Grupo de recursos de Azure del suscriptor. El destino del asociado asociado al canal será
creado en este grupo de recursos.
cuerda
resourceMoveChangeHistory Historial de cambios del traslado de recursos. ResourceMoveChangeHistory[]

PartnerTopicInfo

Nombre Descripción Valor
azureSubscriptionId Identificador de suscripción de Azure del suscriptor. El tema del asociado asociado al canal será
creado en esta suscripción de Azure.
cuerda
eventTypeInfo Información de tipo de evento para el tema del asociado. El publicador proporciona esta información y la puede usar.
suscriptor para ver diferentes tipos de eventos que se publican.
EventTypeInfo
nombre Nombre del tema de asociado asociado al canal. cuerda
resourceGroupName Grupo de recursos de Azure del suscriptor. El tema del asociado asociado al canal será
creado en este grupo de recursos.
cuerda
fuente El publicador proporciona la información de origen para determinar el ámbito o el contexto desde el que se muestran los eventos.
se originan. El suscriptor puede usar esta información durante el proceso de aprobación del
tema de asociado creado.
cuerda

ResourceMoveChangeHistory

Nombre Descripción Valor
azureSubscriptionId Identificador de suscripción de Azure del recurso. cuerda
changedTimeUtc Marca de tiempo UTC de cuándo se cambió el recurso. cuerda
resourceGroupName Grupo de recursos de Azure del recurso. cuerda

WebhookPartnerDestinationInfo

Nombre Descripción Valor
endpointType Tipo del punto de conexión para el destino del asociado "WebHook" (obligatorio)
Propiedades Propiedades de webHook del destino del asociado. webhookPartnerDestinationProperties

WebhookPartnerDestinationProperties

Nombre Descripción Valor
clientAuthentication Autenticación de cliente asociado partnerClientAuthentication
endpointBaseUrl Dirección URL base que representa el punto de conexión del destino del asociado. cuerda
endpointUrl Dirección URL que representa el punto de conexión del destino del asociado. cuerda

Definición de recursos de plantilla de ARM

El tipo de recurso partnerNamespaces/channels se puede implementar con operaciones que tienen como destino:

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.EventGrid/partnerNamespaces/channels, agregue el siguiente JSON a la plantilla.

{
  "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 PartnerClientAuthentication

Establezca la propiedad clientAuthenticationType para especificar el tipo de objeto.

Para azureAD, use:

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

Objetos PartnerDestinationInfo

Establezca la propiedad endpointType para especificar el tipo de objeto.

Para webHook, use:

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

Valores de propiedad

AzureADPartnerClientAuthentication

Nombre Descripción Valor
clientAuthenticationType Tipo de autenticación de cliente "AzureAD" (obligatorio)
Propiedades Propiedades clientAuthentication de AzureAD azureADPartnerClientAuthenticationProperties

AzureADPartnerClientAuthenticationProperties

Nombre Descripción Valor
azureActiveDirectoryApplicationIdOrUri Identificador de aplicación o URI de Azure Active Directory para obtener el token de acceso que se incluirá como token de portador en las solicitudes de entrega. cuerda
azureActiveDirectoryTenantId Identificador de inquilino de Azure Active Directory para obtener el token de acceso que se incluirá como token de portador en las solicitudes de entrega. cuerda

ChannelProperties

Nombre Descripción Valor
channelType Tipo del canal de eventos que representa el flujo de dirección de los eventos. 'PartnerDestination'
'PartnerTopic'
expirationTimeIfNotActivatedUtc Hora de expiración del canal. Si este temporizador expira mientras nunca se activa el tema del asociado correspondiente,
Se eliminan el canal y el tema de asociado correspondiente.
cuerda
messageForActivation Contexto o mensaje útil que el suscriptor puede usar durante el proceso de aprobación. cuerda
partnerDestinationInfo Esta propiedad debe rellenarse cuando channelType es PartnerDestination y representa información sobre el recurso de destino del asociado correspondiente al canal. PartnerDestinationInfo
partnerTopicInfo Esta propiedad debe rellenarse cuando channelType es PartnerTopic y representa información sobre el recurso del tema del asociado correspondiente al canal. partnerTopicInfo
provisioningState Estado de aprovisionamiento del canal. 'Cancelado'
'Crear'
"Eliminar"
'Error'
'IdleDueToMirroredPartnerDestinationDeletion'
'IdleDueToMirroredPartnerTopicDeletion'
"Correcto"
"Actualización"
ReadinessState Estado de preparación del tema de asociado correspondiente. "Activado"
'NeverActivated'

EventTypeInfo

Nombre Descripción Valor
inlineEventTypes Colección de tipos de eventos insertados para el recurso. Las claves de tipo de evento insertadas son de tipo cadena que representa el nombre del evento.
Un ejemplo de un nombre de evento insertado válido es "Contoso.OrderCreated".
Los valores de tipo de evento insertado son de tipo InlineEventProperties y contendrán información adicional para cada tipo de evento insertado.
EventTypeInfoInlineEventTypes
amable Tipo de evento usado. 'Inline'

EventTypeInfoInlineEventTypes

Nombre Descripción Valor

InlineEventProperties

Nombre Descripción Valor
dataSchemaUrl DataSchemaUrl para el evento insertado. cuerda
descripción Descripción del evento insertado. cuerda
displayName DisplayName para el evento insertado. cuerda
documentationUrl DocumentationUrl para el evento insertado. cuerda

Microsoft.EventGrid/partnerNamespaces/channels

Nombre Descripción Valor
apiVersion La versión de api '2024-12-15-preview'
nombre El nombre del recurso string (obligatorio)
Propiedades Propiedades del canal. ChannelProperties
tipo El tipo de recurso 'Microsoft.EventGrid/partnerNamespaces/channels'

PartnerClientAuthentication

Nombre Descripción Valor
clientAuthenticationType Establezca en "AzureAD" para el tipo AzureADPartnerClientAuthentication. "AzureAD" (obligatorio)

PartnerDestinationInfo

Nombre Descripción Valor
azureSubscriptionId Identificador de suscripción de Azure del suscriptor. El destino del asociado asociado al canal será
creado en esta suscripción de Azure.
cuerda
endpointServiceContext Contexto adicional del punto de conexión de destino del asociado. cuerda
endpointType Establezca en "WebHook" para el tipo WebhookPartnerDestinationInfo. "WebHook" (obligatorio)
nombre Nombre del destino del asociado asociado asociado al canal. cuerda
resourceGroupName Grupo de recursos de Azure del suscriptor. El destino del asociado asociado al canal será
creado en este grupo de recursos.
cuerda
resourceMoveChangeHistory Historial de cambios del traslado de recursos. ResourceMoveChangeHistory[]

PartnerTopicInfo

Nombre Descripción Valor
azureSubscriptionId Identificador de suscripción de Azure del suscriptor. El tema del asociado asociado al canal será
creado en esta suscripción de Azure.
cuerda
eventTypeInfo Información de tipo de evento para el tema del asociado. El publicador proporciona esta información y la puede usar.
suscriptor para ver diferentes tipos de eventos que se publican.
EventTypeInfo
nombre Nombre del tema de asociado asociado al canal. cuerda
resourceGroupName Grupo de recursos de Azure del suscriptor. El tema del asociado asociado al canal será
creado en este grupo de recursos.
cuerda
fuente El publicador proporciona la información de origen para determinar el ámbito o el contexto desde el que se muestran los eventos.
se originan. El suscriptor puede usar esta información durante el proceso de aprobación del
tema de asociado creado.
cuerda

ResourceMoveChangeHistory

Nombre Descripción Valor
azureSubscriptionId Identificador de suscripción de Azure del recurso. cuerda
changedTimeUtc Marca de tiempo UTC de cuándo se cambió el recurso. cuerda
resourceGroupName Grupo de recursos de Azure del recurso. cuerda

WebhookPartnerDestinationInfo

Nombre Descripción Valor
endpointType Tipo del punto de conexión para el destino del asociado "WebHook" (obligatorio)
Propiedades Propiedades de webHook del destino del asociado. webhookPartnerDestinationProperties

WebhookPartnerDestinationProperties

Nombre Descripción Valor
clientAuthentication Autenticación de cliente asociado partnerClientAuthentication
endpointBaseUrl Dirección URL base que representa el punto de conexión del destino del asociado. cuerda
endpointUrl Dirección URL que representa el punto de conexión del destino del asociado. cuerda

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso partnerNamespaces/channels se puede implementar con operaciones que tienen como destino:

  • grupos de recursos de

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.EventGrid/partnerNamespaces/channels, agregue el siguiente terraform a la plantilla.

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 PartnerClientAuthentication

Establezca la propiedad clientAuthenticationType para especificar el tipo de objeto.

Para azureAD, use:

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

Objetos PartnerDestinationInfo

Establezca la propiedad endpointType para especificar el tipo de objeto.

Para webHook, use:

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

Valores de propiedad

AzureADPartnerClientAuthentication

Nombre Descripción Valor
clientAuthenticationType Tipo de autenticación de cliente "AzureAD" (obligatorio)
Propiedades Propiedades clientAuthentication de AzureAD azureADPartnerClientAuthenticationProperties

AzureADPartnerClientAuthenticationProperties

Nombre Descripción Valor
azureActiveDirectoryApplicationIdOrUri Identificador de aplicación o URI de Azure Active Directory para obtener el token de acceso que se incluirá como token de portador en las solicitudes de entrega. cuerda
azureActiveDirectoryTenantId Identificador de inquilino de Azure Active Directory para obtener el token de acceso que se incluirá como token de portador en las solicitudes de entrega. cuerda

ChannelProperties

Nombre Descripción Valor
channelType Tipo del canal de eventos que representa el flujo de dirección de los eventos. 'PartnerDestination'
'PartnerTopic'
expirationTimeIfNotActivatedUtc Hora de expiración del canal. Si este temporizador expira mientras nunca se activa el tema del asociado correspondiente,
Se eliminan el canal y el tema de asociado correspondiente.
cuerda
messageForActivation Contexto o mensaje útil que el suscriptor puede usar durante el proceso de aprobación. cuerda
partnerDestinationInfo Esta propiedad debe rellenarse cuando channelType es PartnerDestination y representa información sobre el recurso de destino del asociado correspondiente al canal. PartnerDestinationInfo
partnerTopicInfo Esta propiedad debe rellenarse cuando channelType es PartnerTopic y representa información sobre el recurso del tema del asociado correspondiente al canal. partnerTopicInfo
provisioningState Estado de aprovisionamiento del canal. 'Cancelado'
'Crear'
"Eliminar"
'Error'
'IdleDueToMirroredPartnerDestinationDeletion'
'IdleDueToMirroredPartnerTopicDeletion'
"Correcto"
"Actualización"
ReadinessState Estado de preparación del tema de asociado correspondiente. "Activado"
'NeverActivated'

EventTypeInfo

Nombre Descripción Valor
inlineEventTypes Colección de tipos de eventos insertados para el recurso. Las claves de tipo de evento insertadas son de tipo cadena que representa el nombre del evento.
Un ejemplo de un nombre de evento insertado válido es "Contoso.OrderCreated".
Los valores de tipo de evento insertado son de tipo InlineEventProperties y contendrán información adicional para cada tipo de evento insertado.
EventTypeInfoInlineEventTypes
amable Tipo de evento usado. 'Inline'

EventTypeInfoInlineEventTypes

Nombre Descripción Valor

InlineEventProperties

Nombre Descripción Valor
dataSchemaUrl DataSchemaUrl para el evento insertado. cuerda
descripción Descripción del evento insertado. cuerda
displayName DisplayName para el evento insertado. cuerda
documentationUrl DocumentationUrl para el evento insertado. cuerda

Microsoft.EventGrid/partnerNamespaces/channels

Nombre Descripción Valor
nombre El nombre del recurso string (obligatorio)
parent_id Identificador del recurso que es el elemento primario de este recurso. Identificador del recurso de tipo: partnerNamespaces
Propiedades Propiedades del canal. ChannelProperties
tipo El tipo de recurso "Microsoft.EventGrid/partnerNamespaces/channels@2024-12-15-preview"

PartnerClientAuthentication

Nombre Descripción Valor
clientAuthenticationType Establezca en "AzureAD" para el tipo AzureADPartnerClientAuthentication. "AzureAD" (obligatorio)

PartnerDestinationInfo

Nombre Descripción Valor
azureSubscriptionId Identificador de suscripción de Azure del suscriptor. El destino del asociado asociado al canal será
creado en esta suscripción de Azure.
cuerda
endpointServiceContext Contexto adicional del punto de conexión de destino del asociado. cuerda
endpointType Establezca en "WebHook" para el tipo WebhookPartnerDestinationInfo. "WebHook" (obligatorio)
nombre Nombre del destino del asociado asociado asociado al canal. cuerda
resourceGroupName Grupo de recursos de Azure del suscriptor. El destino del asociado asociado al canal será
creado en este grupo de recursos.
cuerda
resourceMoveChangeHistory Historial de cambios del traslado de recursos. ResourceMoveChangeHistory[]

PartnerTopicInfo

Nombre Descripción Valor
azureSubscriptionId Identificador de suscripción de Azure del suscriptor. El tema del asociado asociado al canal será
creado en esta suscripción de Azure.
cuerda
eventTypeInfo Información de tipo de evento para el tema del asociado. El publicador proporciona esta información y la puede usar.
suscriptor para ver diferentes tipos de eventos que se publican.
EventTypeInfo
nombre Nombre del tema de asociado asociado al canal. cuerda
resourceGroupName Grupo de recursos de Azure del suscriptor. El tema del asociado asociado al canal será
creado en este grupo de recursos.
cuerda
fuente El publicador proporciona la información de origen para determinar el ámbito o el contexto desde el que se muestran los eventos.
se originan. El suscriptor puede usar esta información durante el proceso de aprobación del
tema de asociado creado.
cuerda

ResourceMoveChangeHistory

Nombre Descripción Valor
azureSubscriptionId Identificador de suscripción de Azure del recurso. cuerda
changedTimeUtc Marca de tiempo UTC de cuándo se cambió el recurso. cuerda
resourceGroupName Grupo de recursos de Azure del recurso. cuerda

WebhookPartnerDestinationInfo

Nombre Descripción Valor
endpointType Tipo del punto de conexión para el destino del asociado "WebHook" (obligatorio)
Propiedades Propiedades de webHook del destino del asociado. webhookPartnerDestinationProperties

WebhookPartnerDestinationProperties

Nombre Descripción Valor
clientAuthentication Autenticación de cliente asociado partnerClientAuthentication
endpointBaseUrl Dirección URL base que representa el punto de conexión del destino del asociado. cuerda
endpointUrl Dirección URL que representa el punto de conexión del destino del asociado. cuerda