Compartir a través de

Microsoft.EventGrid partnerNamespaces/channels 2021-10-15-preview

  • Artículo

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 los recursos

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

resource symbolicname 'Microsoft.EventGrid/partnerNamespaces/channels@2021-10-15-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  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'
            documentationUrl: 'string'
          }
        }
        kind: 'Inline'
      }
      name: 'string'
      resourceGroupName: 'string'
      source: 'string'
    }
    provisioningState: 'string'
    readinessState: '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'
  }

Objetos PartnerClientAuthentication

Establezca la propiedad clientAuthenticationType para especificar el tipo de objeto.

Para AzureAD, use:

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

Valores de propiedad

partnerNamespaces/channels

Nombre Descripción Value
name El nombre del recurso

Vea cómo establecer nombres y tipos para recursos secundarios en Bicep.		 string (obligatorio)
primario 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 más información, consulte Recurso secundario fuera del recurso primario.		 Nombre simbólico del recurso de tipo: partnerNamespaces
properties Propiedades del canal. ChannelProperties

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 el tema de asociado correspondiente nunca se activa,
Se eliminan el canal y el tema de asociado correspondiente.		 string
messageForActivation Contexto o mensaje útil que el suscriptor puede usar durante el proceso de aprobación. string
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 de tema del asociado correspondiente al canal. PartnerTopicInfo
provisioningState Estado de aprovisionamiento del canal. 'Cancelado'
'Crear'
'Eliminar'
'Failed'
"Correcto"
'Actualizar'
readinessState Estado de preparación del tema de asociado correspondiente. "Activado"
'NeverActivated'

PartnerDestinationInfo

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

ResourceMoveChangeHistory

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

WebhookPartnerDestinationInfo

Nombre Descripción Valor
endpointType Tipo del punto de conexión para el destino del asociado 'WebHook' (obligatorio)
properties 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. string
endpointUrl Dirección URL que representa el punto de conexión del destino del asociado. string

PartnerClientAuthentication

Nombre Descripción Valor
clientAuthenticationType Establecimiento del tipo de objeto AzureAD (obligatorio)

AzureADPartnerClientAuthentication

Nombre Descripción Valor
clientAuthenticationType Tipo de autenticación de cliente 'AzureAD' (obligatorio)
properties Propiedades de ClientAuthentication de AzureAD AzureADPartnerClientAuthenticationProperties

AzureADPartnerClientAuthenticationProperties

Nombre Descripción Valor
azureActiveDirectoryApplicationIdOrUri Identificador o URI de aplicación de Azure Active Directory para obtener el token de acceso que se incluirá como token de portador en las solicitudes de entrega. string
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. string

PartnerTopicInfo

Nombre Descripción Valor
azureSubscriptionId Identificador de suscripción de Azure del suscriptor. El tema de asociado asociado al canal será
creado en esta suscripción de Azure.		 string
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
name Nombre del tema de asociado asociado al canal. string
resourceGroupName Grupo de recursos de Azure del suscriptor. El tema de asociado asociado al canal será
creado en este grupo de recursos.		 string
source El publicador proporciona la información de origen para determinar el ámbito o el contexto desde el que se realizan los eventos.
se originan. El suscriptor puede usar esta información durante el proceso de aprobación de .
tema de asociado creado.
 string

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
kind Tipo de evento usado. 'Insertado'

EventTypeInfoInlineEventTypes

Nombre Descripción Valor
{propiedad personalizada} InlineEventProperties

InlineEventProperties

Nombre Descripción Valor
dataSchemaUrl DataSchemaUrl para el evento insertado. string
description Descripción del evento insertado. string
documentationUrl DocumentationUrl para el evento insertado. string

Definición de recursos de plantilla de ARM

El tipo de recurso partnerNamespaces/channels se puede implementar con operaciones destinadas a:

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

Formato de los recursos

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

{
  "type": "Microsoft.EventGrid/partnerNamespaces/channels",
  "apiVersion": "2021-10-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",
            "documentationUrl": "string"
          }
        },
        "kind": "Inline"
      },
      "name": "string",
      "resourceGroupName": "string",
      "source": "string"
    },
    "provisioningState": "string",
    "readinessState": "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"
  }

Objetos PartnerClientAuthentication

Establezca la propiedad clientAuthenticationType para especificar el tipo de objeto.

Para AzureAD, use:

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

Valores de propiedad

partnerNamespaces/channels

Nombre Descripción Value
type Tipo de recurso 'Microsoft.EventGrid/partnerNamespaces/channels'
apiVersion La versión de la API de recursos "2021-10-15-preview"
name El nombre del recurso

Vea cómo establecer nombres y tipos para recursos secundarios en plantillas de ARM JSON.		 string (obligatorio)
properties Propiedades del canal. ChannelProperties

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 el tema de asociado correspondiente nunca está activado,
se eliminan el canal y el tema de asociado correspondiente.		 string
messageForActivation Contexto o mensaje útil que el suscriptor puede usar durante el proceso de aprobación. string
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 de tema del asociado correspondiente al canal. PartnerTopicInfo
provisioningState Estado de aprovisionamiento del canal. 'Cancelado'
'Crear'
"Eliminar"
'Error'
'Correcto'
"Actualización"
ReadinessState Estado de preparación del tema de asociado correspondiente. 'Activado'
'NeverActivated'

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.		 string
endpointServiceContext Contexto adicional del punto de conexión de destino del asociado. string
name Nombre del destino del asociado asociado asociado al canal. string
resourceGroupName Grupo de recursos de Azure del suscriptor. El destino del asociado asociado asociado al canal será
creado en este grupo de recursos.		 string
resourceMoveChangeHistory Historial de cambios del traslado de recursos. ResourceMoveChangeHistory[]
endpointType Establecimiento del tipo de objeto WebHook (obligatorio)

ResourceMoveChangeHistory

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

WebhookPartnerDestinationInfo

Nombre Descripción Valor
endpointType Tipo del punto de conexión para el destino del asociado 'WebHook' (obligatorio)
properties 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. string
endpointUrl Dirección URL que representa el punto de conexión del destino del asociado. string

PartnerClientAuthentication

Nombre Descripción Valor
clientAuthenticationType Establecimiento del tipo de objeto AzureAD (obligatorio)

AzureADPartnerClientAuthentication

Nombre Descripción Valor
clientAuthenticationType Tipo de autenticación de cliente "AzureAD" (obligatorio)
properties Propiedades de ClientAuthentication de AzureAD AzureADPartnerClientAuthenticationProperties

AzureADPartnerClientAuthenticationProperties

Nombre Descripción Valor
azureActiveDirectoryApplicationIdOrUri Identificador o URI de aplicación de Azure Active Directory para obtener el token de acceso que se incluirá como token de portador en las solicitudes de entrega. string
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. string

PartnerTopicInfo

Nombre Descripción Valor
azureSubscriptionId Identificador de suscripción de Azure del suscriptor. El tema de asociado asociado al canal será
creado en esta suscripción de Azure.		 string
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
name Nombre del tema del asociado asociado al canal. string
resourceGroupName Grupo de recursos de Azure del suscriptor. El tema de asociado asociado al canal será
creado en este grupo de recursos.		 string
source El publicador proporciona la información de origen para determinar el ámbito o el contexto desde el que los eventos
se originan. El suscriptor puede usar esta información durante el proceso de aprobación del
tema de asociado creado.
 string

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 insertados son de tipo InlineEventProperties y contendrán información adicional para cada tipo de evento insertado.		 EventTypeInfoInlineEventTypes
kind Tipo de evento utilizado. "Insertado"

EventTypeInfoInlineEventTypes

Nombre Descripción Valor
{propiedad personalizada} InlineEventProperties

InlineEventProperties

Nombre Descripción Valor
dataSchemaUrl DataSchemaUrl para el evento insertado. string
description Descripción del evento insertado. string
documentationUrl DocumentationUrl para el evento insertado. string

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

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

Formato de los recursos

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/partnerNamespaces/channels@2021-10-15-preview"
  name = "string"
  parent_id = "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"
              documentationUrl = "string"
            }
          }
          kind = "Inline"
        }
        name = "string"
        resourceGroupName = "string"
        source = "string"
      }
      provisioningState = "string"
      readinessState = "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"
  }

Objetos PartnerClientAuthentication

Establezca la propiedad clientAuthenticationType para especificar el tipo de objeto.

Para AzureAD, use:

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

Valores de propiedad

partnerNamespaces/channels

Nombre Descripción Value
type Tipo de recurso "Microsoft.EventGrid/partnerNamespaces/channels@2021-10-15-preview"
name 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
properties Propiedades del canal. ChannelProperties

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 el tema de asociado correspondiente nunca se activa,
Se eliminan el canal y el tema de asociado correspondiente.		 string
messageForActivation Contexto o mensaje útil que el suscriptor puede usar durante el proceso de aprobación. string
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 de tema del asociado correspondiente al canal. PartnerTopicInfo
provisioningState Estado de aprovisionamiento del canal. "Cancelado"
"Creación"
"Eliminación"
"Error"
"Correcto"
"Actualización"
readinessState Estado de preparación del tema de asociado correspondiente. "Activado"
"NeverActivated"

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.		 string
endpointServiceContext Contexto adicional del punto de conexión de destino del asociado. string
name Nombre del destino del asociado asociado asociado al canal. string
resourceGroupName Grupo de recursos de Azure del suscriptor. El destino del asociado asociado al canal será
creado en este grupo de recursos.		 string
resourceMoveChangeHistory Cambiar el historial del traslado de recursos. ResourceMoveChangeHistory[]
endpointType Establecimiento del tipo de objeto WebHook (obligatorio)

ResourceMoveChangeHistory

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

WebhookPartnerDestinationInfo

Nombre Descripción Valor
endpointType Tipo del punto de conexión para el destino del asociado "WebHook" (obligatorio)
properties 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. string
endpointUrl Dirección URL que representa el punto de conexión del destino del asociado. string

PartnerClientAuthentication

Nombre Descripción Valor
clientAuthenticationType Establecimiento del tipo de objeto AzureAD (obligatorio)

AzureADPartnerClientAuthentication

Nombre Descripción Valor
clientAuthenticationType Tipo de autenticación de cliente "AzureAD" (obligatorio)
properties Propiedades de ClientAuthentication de AzureAD AzureADPartnerClientAuthenticationProperties

AzureADPartnerClientAuthenticationProperties

Nombre Descripción Valor
azureActiveDirectoryApplicationIdOrUri Identificador o URI de aplicación de Azure Active Directory para obtener el token de acceso que se incluirá como token de portador en las solicitudes de entrega. string
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. string

PartnerTopicInfo

Nombre Descripción Valor
azureSubscriptionId Identificador de suscripción de Azure del suscriptor. El tema de asociado asociado al canal será
creado en esta suscripción de Azure.		 string
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
name Nombre del tema de asociado asociado al canal. string
resourceGroupName Grupo de recursos de Azure del suscriptor. El tema de asociado asociado al canal será
creado en este grupo de recursos.		 string
source El publicador proporciona la información de origen para determinar el ámbito o el contexto desde el que se realizan los eventos.
se originan. El suscriptor puede usar esta información durante el proceso de aprobación de .
tema de asociado creado.
 string

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
kind Tipo de evento usado. "Insertado"

EventTypeInfoInlineEventTypes

Nombre Descripción Valor
{propiedad personalizada} InlineEventProperties

InlineEventProperties

Nombre Descripción Valor
dataSchemaUrl DataSchemaUrl para el evento insertado. string
description Descripción del evento insertado. string
documentationUrl DocumentationUrl para el evento insertado. string