Condividi tramite

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

  • Articolo

Definizione di risorsa Bicep

Il tipo di risorsa partnerNamespaces/channels può essere distribuito con operazioni destinate a:

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere Log delle modifiche.

Formato di risorsa

Per creare una risorsa Microsoft.EventGrid/partnerNamespaces/channels, aggiungere il bicep seguente al modello.

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'
  }
}

Oggetti PartnerDestinationInfo

Impostare la proprietà endpointType per specificare il tipo di oggetto.

Per WebHook, usare:

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

Oggetti PartnerClientAuthentication

Impostare la proprietà clientAuthenticationType per specificare il tipo di oggetto.

Per AzureAD, usare:

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

Valori delle proprietà

partnerNamespaces/channels

Nome Descrizione valore
name Nome della risorsa

Vedere come impostare nomi e tipi per le risorse figlio in Bicep.		 stringa (obbligatorio)
padre In Bicep è possibile specificare la risorsa padre per una risorsa figlio. È necessario aggiungere questa proprietà solo quando la risorsa figlio viene dichiarata all'esterno della risorsa padre.

Per altre informazioni, vedere Risorsa figlio esterna alla risorsa padre.		 Nome simbolico per la risorsa di tipo: partnerNamespaces
properties Proprietà del canale. ChannelProperties

ChannelProperties

Nome Descrizione Valore
channelType Tipo del canale dell'evento che rappresenta il flusso di direzione degli eventi. 'PartnerDestination'
'PartnerTopic'
expirationTimeIfNotActivatedUtc Scadenza del canale. Se questo timer scade mentre l'argomento partner corrispondente non viene mai attivato,
il canale e l'argomento partner corrispondente vengono eliminati.		 string
messageForActivation Contesto o messaggio utile che può essere usato durante il processo di approvazione da parte del sottoscrittore. string
partnerDestinationInfo Questa proprietà deve essere popolata quando channelType è PartnerDestination e rappresenta le informazioni sulla risorsa di destinazione partner corrispondente al canale. PartnerDestinationInfo
partnerTopicInfo Questa proprietà deve essere popolata quando channelType è PartnerTopic e rappresenta le informazioni sulla risorsa dell'argomento partner corrispondente al canale. PartnerTopicInfo
provisioningState Stato di provisioning del canale. 'Annullata'
'Creating'
'Eliminazione'
'Failed'
'Succeeded'
'Aggiornamento'
readinessState Stato di conformità dell'argomento partner corrispondente. 'Attivato'
'NeverActivated'

PartnerDestinationInfo

Nome Descrizione Valore
azureSubscriptionId ID sottoscrizione di Azure del sottoscrittore. La destinazione partner associata al canale sarà
creato in questa sottoscrizione di Azure.		 string
endpointServiceContext Contesto aggiuntivo dell'endpoint di destinazione partner. string
name Nome della destinazione partner associata al canale. string
resourceGroupName Gruppo di risorse di Azure del sottoscrittore. La destinazione partner associata al canale sarà
creato in questo gruppo di risorse.		 string
resourceMoveChangeHistory Cronologia delle modifiche dello spostamento della risorsa. ResourceMoveChangeHistory[]
endpointType Impostare il tipo di oggetto WebHook (obbligatorio)

ResourceMoveChangeHistory

Nome Descrizione Valore
azureSubscriptionId ID sottoscrizione di Azure della risorsa. string
changedTimeUtc Timestamp UTC di quando la risorsa è stata modificata. string
resourceGroupName Gruppo di risorse di Azure della risorsa. string

WebhookPartnerDestinationInfo

Nome Descrizione Valore
endpointType Tipo di endpoint per la destinazione partner 'WebHook' (obbligatorio)
properties Proprietà webhook della destinazione partner. WebhookPartnerDestinationProperties

WebhookPartnerDestinationProperties

Nome Descrizione Valore
clientAuthentication Autenticazione client partner PartnerClientAuthentication
endpointBaseUrl URL di base che rappresenta l'endpoint della destinazione partner. string
endpointUrl URL che rappresenta l'endpoint della destinazione partner. string

PartnerClientAuthentication

Nome Descrizione Valore
clientAuthenticationType Impostare il tipo di oggetto AzureAD (obbligatorio)

AzureADPartnerClientAuthentication

Nome Descrizione Valore
clientAuthenticationType Tipo di autenticazione client 'AzureAD' (obbligatorio)
properties Proprietà di AzureAD ClientAuthentication AzureADPartnerClientAuthenticationProperties

AzureADPartnerClientAuthenticationProperties

Nome Descrizione Valore
azureActiveDirectoryApplicationIdOrUri ID applicazione o URI di Azure Active Directory per ottenere il token di accesso che verrà incluso come token di connessione nelle richieste di recapito. string
azureActiveDirectoryTenantId ID tenant di Azure Active Directory per ottenere il token di accesso che verrà incluso come token di connessione nelle richieste di recapito. string

PartnerTopicInfo

Nome Descrizione Valore
azureSubscriptionId ID sottoscrizione di Azure del sottoscrittore. L'argomento del partner associato al canale sarà
creato in questa sottoscrizione di Azure.		 string
eventTypeInfo Informazioni sul tipo di evento per l'argomento partner. Queste informazioni vengono fornite dal server di pubblicazione e possono essere utilizzate dal
sottoscrittore per visualizzare diversi tipi di eventi pubblicati.		 EventTypeInfo
name Nome dell'argomento partner associato al canale. string
resourceGroupName Gruppo di risorse di Azure del sottoscrittore. L'argomento del partner associato al canale sarà
creato in questo gruppo di risorse.		 string
source Le informazioni sull'origine vengono fornite dal server di pubblicazione per determinare l'ambito o il contesto da cui gli eventi
sono di origine. Queste informazioni possono essere utilizzate dal sottoscrittore durante il processo di approvazione del
argomento del partner creato.
 string

EventTypeInfo

Nome Descrizione Valore
inlineEventTypes Raccolta di tipi di evento inline per la risorsa. Le chiavi del tipo di evento inline sono di tipo stringa che rappresenta il nome dell'evento.
Un esempio di nome di evento inline valido è "Contoso.OrderCreated".
I valori del tipo di evento inline sono di tipo InlineEventProperties e conterranno informazioni aggiuntive per ogni tipo di evento inline.		 EventTypeInfoInlineEventTypes
kind Tipo di evento usato. 'Inline'

EventTypeInfoInlineEventTypes

Nome Descrizione Valore
{proprietà personalizzata} InlineEventProperties

InlineEventProperties

Nome Descrizione Valore
dataSchemaUrl DataSchemaUrl per l'evento inline. string
description Descrizione dell'evento inline. string
documentationUrl DocumentazioneUrl per l'evento inline. string

Definizione della risorsa modello di Resource Manager

Il tipo di risorsa partnerNamespaces/channel può essere distribuito con operazioni destinate:

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato di risorsa

Per creare una risorsa Microsoft.EventGrid/partnerNamespaces/channel, aggiungere il codice JSON seguente al modello.

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

Oggetti PartnerDestinationInfo

Impostare la proprietà endpointType per specificare il tipo di oggetto.

Per WebHook, usare:

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

Oggetti PartnerClientAuthentication

Impostare la proprietà clientAuthenticationType per specificare il tipo di oggetto.

Per AzureAD, usare:

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

Valori delle proprietà

partnerNamespaces/channel

Nome Descrizione Valore
tipo Tipo di risorsa 'Microsoft.EventGrid/partnerNamespaces/channels'
apiVersion Versione dell'API risorsa '2021-10-15-preview'
name Nome della risorsa

Vedere come impostare nomi e tipi per le risorse figlio nei modelli di RESOURCE JSON.		 stringa (obbligatoria)
properties Proprietà del canale. ChannelProperties

ChannelProperties

Nome Descrizione Valore
channelType Tipo del canale evento che rappresenta il flusso di direzione degli eventi. 'PartnerDestination'
'PartnerTopic'
expirationTimeIfNotActivatedUtc Ora di scadenza del canale. Se questo timer scade mentre l'argomento partner corrispondente non viene mai attivato,
il canale e l'argomento partner corrispondente vengono eliminati.		 string
messageForActivation Contesto o messaggio utile che può essere usato durante il processo di approvazione dal sottoscrittore. string
partnerDestinationInfo Questa proprietà deve essere popolata quando channelType è PartnerDestination e rappresenta le informazioni sulla risorsa di destinazione partner corrispondente al canale. PartnerDestinationInfo
partnerTopicInfo Questa proprietà deve essere popolata quando channelType è PartnerTopic e rappresenta le informazioni sulla risorsa dell'argomento partner corrispondente al canale. PartnerTopicInfo
provisioningState Stato di provisioning del canale. 'Annullata'
'Creazione'
'Eliminazione'
'Non riuscito'
'Successed'
'Aggiornamento'
idoneitàState Stato di conformità dell'argomento partner corrispondente. 'Attivato'
'NeverActivated'

PartnerDestinationInfo

Nome Descrizione Valore
azureSubscriptionId ID sottoscrizione di Azure del sottoscrittore. La destinazione partner associata al canale sarà
creato in questa sottoscrizione di Azure.		 string
endpointServiceContext Contesto aggiuntivo dell'endpoint di destinazione partner. string
name Nome della destinazione partner associata al canale. string
resourceGroupName Gruppo di risorse di Azure del sottoscrittore. La destinazione partner associata al canale sarà
creato in questo gruppo di risorse.		 string
resourceMoveChangeHistory Cronologia delle modifiche dello spostamento della risorsa. ResourceMoveChangeHistory[]
endpointType Impostare il tipo di oggetto WebHook (obbligatorio)

ResourceMoveChangeHistory

Nome Descrizione Valore
azureSubscriptionId ID sottoscrizione di Azure della risorsa. string
changedTimeUtc Timestamp UTC di quando la risorsa è stata modificata. string
resourceGroupName Gruppo di risorse di Azure della risorsa. string

WebhookPartnerDestinationInfo

Nome Descrizione Valore
endpointType Tipo di endpoint per la destinazione partner 'WebHook' (obbligatorio)
properties Proprietà webhook della destinazione partner. WebhookPartnerDestinationProperties

WebhookPartnerDestinationProperties

Nome Descrizione Valore
clientAuthentication Autenticazione client partner PartnerClientAuthentication
endpointBaseUrl URL di base che rappresenta l'endpoint della destinazione partner. string
endpointUrl URL che rappresenta l'endpoint della destinazione partner. string

PartnerClientAuthentication

Nome Descrizione Valore
clientAuthenticationType Impostare il tipo di oggetto AzureAD (obbligatorio)

AzureADPartnerClientAuthentication

Nome Descrizione Valore
clientAuthenticationType Tipo di autenticazione client 'AzureAD' (obbligatorio)
properties Proprietà di AzureAD ClientAuthentication AzureADPartnerClientAuthenticationProperties

AzureADPartnerClientAuthenticationProperties

Nome Descrizione Valore
azureActiveDirectoryApplicationIdOrUri ID applicazione o URI di Azure Active Directory per ottenere il token di accesso che verrà incluso come token di connessione nelle richieste di recapito. string
azureActiveDirectoryTenantId ID tenant di Azure Active Directory per ottenere il token di accesso che verrà incluso come token di connessione nelle richieste di recapito. string

PartnerTopicInfo

Nome Descrizione Valore
azureSubscriptionId ID sottoscrizione di Azure del sottoscrittore. L'argomento del partner associato al canale sarà
creato in questa sottoscrizione di Azure.		 string
eventTypeInfo Informazioni sul tipo di evento per l'argomento partner. Queste informazioni vengono fornite dal server di pubblicazione e possono essere utilizzate dal
sottoscrittore per visualizzare diversi tipi di eventi pubblicati.		 EventTypeInfo
name Nome dell'argomento partner associato al canale. string
resourceGroupName Gruppo di risorse di Azure del sottoscrittore. L'argomento del partner associato al canale sarà
creato in questo gruppo di risorse.		 string
source Le informazioni sull'origine vengono fornite dal server di pubblicazione per determinare l'ambito o il contesto da cui gli eventi
sono di origine. Queste informazioni possono essere utilizzate dal sottoscrittore durante il processo di approvazione del
argomento del partner creato.
 string

EventTypeInfo

Nome Descrizione Valore
inlineEventTypes Raccolta di tipi di evento inline per la risorsa. Le chiavi del tipo di evento inline sono di tipo stringa che rappresenta il nome dell'evento.
Un esempio di nome di evento inline valido è "Contoso.OrderCreated".
I valori del tipo di evento inline sono di tipo InlineEventProperties e conterranno informazioni aggiuntive per ogni tipo di evento inline.		 EventTypeInfoInlineEventTypes
kind Tipo di evento utilizzato. 'Inline'

EventTypeInfoInlineEventTypes

Nome Descrizione Valore
{proprietà personalizzata} InlineEventProperties

InlineEventProperties

Nome Descrizione Valore
dataSchemaUrl DataSchemaUrl per l'evento inline. string
description Descrizione dell'evento inline. string
documentationUrl DocumentazioneUrl per l'evento inline. string

Definizione della risorsa Terraform (provider AzAPI)

Il tipo di risorsa partnerNamespaces/channels può essere distribuito con operazioni destinate a:

  • Gruppi di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere Log delle modifiche.

Formato di risorsa

Per creare una risorsa Microsoft.EventGrid/partnerNamespaces/channels, aggiungere il codice Terraform seguente al modello.

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"
    }
  })
}

Oggetti PartnerDestinationInfo

Impostare la proprietà endpointType per specificare il tipo di oggetto.

Per WebHook, usare:

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

Oggetti PartnerClientAuthentication

Impostare la proprietà clientAuthenticationType per specificare il tipo di oggetto.

Per AzureAD, usare:

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

Valori delle proprietà

partnerNamespaces/channels

Nome Descrizione Valore
tipo Tipo di risorsa "Microsoft.EventGrid/partnerNamespaces/channels@2021-10-15-preview"
name Nome della risorsa stringa (obbligatorio)
parent_id ID della risorsa padre per questa risorsa. ID per la risorsa di tipo: partnerNamespaces
properties Proprietà del canale. ChannelProperties

ChannelProperties

Nome Descrizione Valore
channelType Tipo del canale dell'evento che rappresenta il flusso di direzione degli eventi. "PartnerDestination"
"PartnerTopic"
expirationTimeIfNotActivatedUtc Scadenza del canale. Se questo timer scade mentre l'argomento partner corrispondente non viene mai attivato,
il canale e l'argomento partner corrispondente vengono eliminati.		 string
messageForActivation Contesto o messaggio utile che può essere usato durante il processo di approvazione da parte del sottoscrittore. string
partnerDestinationInfo Questa proprietà deve essere popolata quando channelType è PartnerDestination e rappresenta le informazioni sulla risorsa di destinazione partner corrispondente al canale. PartnerDestinationInfo
partnerTopicInfo Questa proprietà deve essere popolata quando channelType è PartnerTopic e rappresenta le informazioni sulla risorsa dell'argomento partner corrispondente al canale. PartnerTopicInfo
provisioningState Stato di provisioning del canale. "Annullato"
"Creazione"
"Eliminazione"
"Failed"
"Succeeded"
"Aggiornamento"
readinessState Stato di conformità dell'argomento partner corrispondente. "Attivato"
"NeverActivated"

PartnerDestinationInfo

Nome Descrizione Valore
azureSubscriptionId ID sottoscrizione di Azure del sottoscrittore. La destinazione partner associata al canale sarà
creato in questa sottoscrizione di Azure.		 string
endpointServiceContext Contesto aggiuntivo dell'endpoint di destinazione partner. string
name Nome della destinazione partner associata al canale. string
resourceGroupName Gruppo di risorse di Azure del sottoscrittore. La destinazione partner associata al canale sarà
creato in questo gruppo di risorse.		 string
resourceMoveChangeHistory Modificare la cronologia dello spostamento della risorsa. ResourceMoveChangeHistory[]
endpointType Impostare il tipo di oggetto WebHook (obbligatorio)

ResourceMoveChangeHistory

Nome Descrizione Valore
azureSubscriptionId ID sottoscrizione di Azure della risorsa. string
changedTimeUtc Timestamp UTC di quando la risorsa è stata modificata. string
resourceGroupName Gruppo di risorse di Azure della risorsa. string

WebhookPartnerDestinationInfo

Nome Descrizione Valore
endpointType Tipo dell'endpoint per la destinazione partner "WebHook" (obbligatorio)
properties Proprietà webhook della destinazione partner. WebhookPartnerDestinationProperties

WebhookPartnerDestinationProperties

Nome Descrizione Valore
clientAuthentication Autenticazione client partner PartnerClientAuthentication
endpointBaseUrl URL di base che rappresenta l'endpoint della destinazione partner. string
endpointUrl URL che rappresenta l'endpoint della destinazione partner. string

PartnerClientAuthentication

Nome Descrizione Valore
clientAuthenticationType Impostare il tipo di oggetto AzureAD (obbligatorio)

AzureADPartnerClientAuthentication

Nome Descrizione Valore
clientAuthenticationType Tipo di autenticazione client "AzureAD" (obbligatorio)
properties Proprietà di AzureAD ClientAuthentication AzureADPartnerClientAuthenticationProperties

AzureADPartnerClientAuthenticationProperties

Nome Descrizione Valore
azureActiveDirectoryApplicationIdOrUri ID applicazione di Azure Active Directory o URI per ottenere il token di accesso che verrà incluso come token di connessione nelle richieste di recapito. string
azureActiveDirectoryTenantId ID tenant di Azure Active Directory per ottenere il token di accesso che verrà incluso come token di connessione nelle richieste di recapito. string

PartnerTopicInfo

Nome Descrizione Valore
azureSubscriptionId ID sottoscrizione di Azure del sottoscrittore. L'argomento partner associato al canale sarà
creato in questa sottoscrizione di Azure.		 string
eventTypeInfo Informazioni sul tipo di evento per l'argomento partner. Queste informazioni vengono fornite dal server di pubblicazione e possono essere usate dal
sottoscrittore per visualizzare diversi tipi di eventi pubblicati.		 EventTypeInfo
name Nome dell'argomento partner associato al canale. string
resourceGroupName Gruppo di risorse di Azure del sottoscrittore. L'argomento partner associato al canale sarà
creato in questo gruppo di risorse.		 string
source Le informazioni di origine vengono fornite dal server di pubblicazione per determinare l'ambito o il contesto da cui gli eventi
sono di origine. Queste informazioni possono essere usate dal sottoscrittore durante il processo di approvazione del
argomento del partner creato.
 string

EventTypeInfo

Nome Descrizione Valore
inlineEventTypes Raccolta di tipi di eventi inline per la risorsa. Le chiavi del tipo di evento inline sono di tipo stringa che rappresenta il nome dell'evento.
Un esempio di nome evento inline valido è "Contoso.OrderCreated".
I valori del tipo di evento inline sono di tipo InlineEventProperties e contengono informazioni aggiuntive per ogni tipo di evento inline.		 EventTypeInfoInlineEventTypes
kind Tipo di evento usato. "Inline"

EventTypeInfoInlineEventTypes

Nome Descrizione Valore
{proprietà personalizzata} InlineEventProperties

InlineEventProperties

Nome Descrizione Valore
dataSchemaUrl DataSchemaUrl per l'evento inline. string
description Descrizione dell'evento inline. string
documentationUrl DocumentazioneUrl per l'evento inline. string