Microsoft.EventGrid partnerNamespaces/channels 2023-12-15-preview
- nejnovější
-
12. 12. 2024 ve verzi Preview -
2024-06-01-preview - z 12. 12. 2023 ve verzi Preview
-
2023-06-01-preview - 15. 6. 2022
-
10. 10. 2021 ve verzi Preview
Definice prostředku Bicep
Typ prostředku partnerNamespaces/channels je možné nasadit s operacemi, které cílí:
- skupiny prostředků – viz příkazy nasazení skupiny prostředků
Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.
Formát prostředku
Pokud chcete vytvořit prostředek Microsoft.EventGrid/partnerNamespaces/channels, přidejte do šablony následující bicep.
resource symbolicname 'Microsoft.EventGrid/partnerNamespaces/channels@2023-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'
}
}
Objekty PartnerClientAuthentication
Nastavte clientAuthenticationType vlastnost určit typ objektu.
Pro AzureAD použijte:
{
clientAuthenticationType: 'AzureAD'
properties: {
azureActiveDirectoryApplicationIdOrUri: 'string'
azureActiveDirectoryTenantId: 'string'
}
}
Objekty PartnerDestinationInfo
Nastavte vlastnost endpointType, která určuje typ objektu.
Pro webhookpoužijte:
{
endpointType: 'WebHook'
properties: {
clientAuthentication: {
clientAuthenticationType: 'string'
// For remaining properties, see PartnerClientAuthentication objects
}
endpointBaseUrl: 'string'
endpointUrl: 'string'
}
}
Hodnoty vlastností
AzureADPartnerClientAuthentication
Jméno | Popis | Hodnota |
---|---|---|
clientAuthenticationType | Typ ověřování klientů | AzureAD (povinné) |
vlastnosti | AzureAD ClientAuthentication – vlastnosti | azureADPartnerClientAuthenticationProperties |
AzureADPartnerClientAuthenticationProperties
Jméno | Popis | Hodnota |
---|---|---|
azureActiveDirectoryApplicationIdOrUri | ID aplikace Azure Active Directory nebo identifikátor URI pro získání přístupového tokenu, který bude zahrnut jako nosný token v žádostech o doručení. | řetězec |
azureActiveDirectoryTenantId | ID tenanta Azure Active Directory pro získání přístupového tokenu, který bude zahrnut jako nosný token v žádostech o doručení. | řetězec |
ChannelProperties
Jméno | Popis | Hodnota |
---|---|---|
channelType | Typ kanálu události, který představuje směr toku událostí. | PartnerDestination PartnerTopic |
expirationTimeIfNotActivatedUtc | Čas vypršení platnosti kanálu Pokud tento časovač vyprší, zatímco odpovídající téma partnera se nikdy neaktivuje, kanál a odpovídající téma partnera se odstraní. |
řetězec |
messageForActivation | Kontext nebo užitečná zpráva, kterou může odběratel použít během procesu schvalování. | řetězec |
partnerDestinationInfo | Tato vlastnost by měla být naplněna, když channelType je PartnerDestination a představuje informace o cílovém prostředku partnera odpovídajícímu kanálu. | PartnerDestinationInfo |
partnerTopicInfo | Tato vlastnost by měla být naplněna, pokud je typem channelType PartnerTopic a představuje informace o prostředku tématu partnera odpovídajícímu kanálu. | PartnerTopicInfo |
provisioningState | Stav zřizování kanálu | Zrušeno Vytváření Odstranění Chyba 'IdleDueToMirroredPartnerDestinationDeletion' 'IdleDueToMirroredPartnerTopicDeletion' Úspěch Aktualizace |
Stav připravenosti | Stav připravenosti odpovídajícího tématu partnera. | Aktivované NeverActivated |
EventTypeInfo
EventTypeInfoInlineEventTypes
Jméno | Popis | Hodnota |
---|
InlineEventProperties
Jméno | Popis | Hodnota |
---|---|---|
dataSchemaUrl | DataSchemaUrl pro vloženou událost. | řetězec |
popis | Popis vložené události. | řetězec |
displayName | DisplayName vložené události. | řetězec |
documentationUrl | DokumentaceUrl pro vloženou událost. | řetězec |
Microsoft.EventGrid/partnerNamespaces/channels
Jméno | Popis | Hodnota |
---|---|---|
Jméno | Název prostředku | string (povinné) |
rodič | V bicep můžete zadat nadřazený prostředek pro podřízený prostředek. Tuto vlastnost je potřeba přidat pouze v případě, že je podřízený prostředek deklarován mimo nadřazený prostředek. Další informace najdete v tématu Podřízený prostředek mimo nadřazený prostředek. |
Symbolický název prostředku typu: partnerNamespaces |
vlastnosti | Vlastnosti kanálu. | |
PartnerClientAuthentication
Jméno | Popis | Hodnota |
---|---|---|
clientAuthenticationType | Pro typ AzureADPartnerClientAuthenticationnastavte hodnotu AzureAD . | AzureAD (povinné) |
PartnerDestinationInfo
Jméno | Popis | Hodnota |
---|---|---|
azureSubscriptionId | ID předplatného Azure odběratele Cíl partnera přidružený ke kanálu bude vytvořené v rámci tohoto předplatného Azure. |
řetězec |
endpointServiceContext | Další kontext cílového koncového bodu partnera | řetězec |
endpointType | Pro typ WebhookPartnerDestinationInfonastavte hodnotu WebHook. | WebHook (povinné) |
Jméno | Název cíle partnera přidruženého k kanálu | řetězec |
resourceGroupName | Skupina prostředků Azure odběratele Cíl partnera přidružený ke kanálu bude vytvořeno v rámci této skupiny prostředků. |
řetězec |
resourceMoveChangeHistory | Změna historie přesunu prostředku | ResourceMoveChangeHistory[] |
PartnerTopicInfo
ResourceMoveChangeHistory
Jméno | Popis | Hodnota |
---|---|---|
azureSubscriptionId | ID předplatného Azure prostředku | řetězec |
changedTimeUtc | Časové razítko UTC, kdy byl prostředek změněn. | řetězec |
resourceGroupName | Skupina prostředků Azure prostředku | řetězec |
WebhookPartnerDestinationInfo
Jméno | Popis | Hodnota |
---|---|---|
endpointType | Typ koncového bodu cíle partnera | WebHook (povinné) |
vlastnosti | Vlastnosti webhooku cílového cíle partnera | webhookPartnerDestinationProperties |
WebhookPartnerDestinationProperties
Jméno | Popis | Hodnota |
---|---|---|
clientAuthentication | Ověřování partnerského klienta | PartnerClientAuthentication |
endpointBaseUrl | Základní adresa URL, která představuje koncový bod cíle partnera. | řetězec |
endpointUrl | Adresa URL, která představuje koncový bod cíle partnera. | řetězec |
Definice prostředku šablony ARM
Typ prostředku partnerNamespaces/channels je možné nasadit s operacemi, které cílí:
- skupiny prostředků – viz příkazy nasazení skupiny prostředků
Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.
Formát prostředku
Pokud chcete vytvořit prostředek Microsoft.EventGrid/partnerNamespaces/channels, přidejte do šablony následující JSON.
{
"type": "Microsoft.EventGrid/partnerNamespaces/channels",
"apiVersion": "2023-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"
}
}
Objekty PartnerClientAuthentication
Nastavte clientAuthenticationType vlastnost určit typ objektu.
Pro AzureAD použijte:
{
"clientAuthenticationType": "AzureAD",
"properties": {
"azureActiveDirectoryApplicationIdOrUri": "string",
"azureActiveDirectoryTenantId": "string"
}
}
Objekty PartnerDestinationInfo
Nastavte vlastnost endpointType, která určuje typ objektu.
Pro webhookpoužijte:
{
"endpointType": "WebHook",
"properties": {
"clientAuthentication": {
"clientAuthenticationType": "string"
// For remaining properties, see PartnerClientAuthentication objects
},
"endpointBaseUrl": "string",
"endpointUrl": "string"
}
}
Hodnoty vlastností
AzureADPartnerClientAuthentication
Jméno | Popis | Hodnota |
---|---|---|
clientAuthenticationType | Typ ověřování klientů | AzureAD (povinné) |
vlastnosti | AzureAD ClientAuthentication – vlastnosti | azureADPartnerClientAuthenticationProperties |
AzureADPartnerClientAuthenticationProperties
Jméno | Popis | Hodnota |
---|---|---|
azureActiveDirectoryApplicationIdOrUri | ID aplikace Azure Active Directory nebo identifikátor URI pro získání přístupového tokenu, který bude zahrnut jako nosný token v žádostech o doručení. | řetězec |
azureActiveDirectoryTenantId | ID tenanta Azure Active Directory pro získání přístupového tokenu, který bude zahrnut jako nosný token v žádostech o doručení. | řetězec |
ChannelProperties
Jméno | Popis | Hodnota |
---|---|---|
channelType | Typ kanálu události, který představuje směr toku událostí. | PartnerDestination PartnerTopic |
expirationTimeIfNotActivatedUtc | Čas vypršení platnosti kanálu Pokud tento časovač vyprší, zatímco odpovídající téma partnera se nikdy neaktivuje, kanál a odpovídající téma partnera se odstraní. |
řetězec |
messageForActivation | Kontext nebo užitečná zpráva, kterou může odběratel použít během procesu schvalování. | řetězec |
partnerDestinationInfo | Tato vlastnost by měla být naplněna, když channelType je PartnerDestination a představuje informace o cílovém prostředku partnera odpovídajícímu kanálu. | PartnerDestinationInfo |
partnerTopicInfo | Tato vlastnost by měla být naplněna, pokud je typem channelType PartnerTopic a představuje informace o prostředku tématu partnera odpovídajícímu kanálu. | PartnerTopicInfo |
provisioningState | Stav zřizování kanálu | Zrušeno Vytváření Odstranění Chyba 'IdleDueToMirroredPartnerDestinationDeletion' 'IdleDueToMirroredPartnerTopicDeletion' Úspěch Aktualizace |
Stav připravenosti | Stav připravenosti odpovídajícího tématu partnera. | Aktivované NeverActivated |
EventTypeInfo
EventTypeInfoInlineEventTypes
Jméno | Popis | Hodnota |
---|
InlineEventProperties
Jméno | Popis | Hodnota |
---|---|---|
dataSchemaUrl | DataSchemaUrl pro vloženou událost. | řetězec |
popis | Popis vložené události. | řetězec |
displayName | DisplayName vložené události. | řetězec |
documentationUrl | DokumentaceUrl pro vloženou událost. | řetězec |
Microsoft.EventGrid/partnerNamespaces/channels
Jméno | Popis | Hodnota |
---|---|---|
apiVersion | Verze rozhraní API | 2023-12-15-preview |
Jméno | Název prostředku | string (povinné) |
vlastnosti | Vlastnosti kanálu. | |
typ | Typ prostředku | Microsoft.EventGrid/partnerNamespaces/channels |
PartnerClientAuthentication
Jméno | Popis | Hodnota |
---|---|---|
clientAuthenticationType | Pro typ AzureADPartnerClientAuthenticationnastavte hodnotu AzureAD . | AzureAD (povinné) |
PartnerDestinationInfo
Jméno | Popis | Hodnota |
---|---|---|
azureSubscriptionId | ID předplatného Azure odběratele Cíl partnera přidružený ke kanálu bude vytvořené v rámci tohoto předplatného Azure. |
řetězec |
endpointServiceContext | Další kontext cílového koncového bodu partnera | řetězec |
endpointType | Pro typ WebhookPartnerDestinationInfonastavte hodnotu WebHook. | WebHook (povinné) |
Jméno | Název cíle partnera přidruženého k kanálu | řetězec |
resourceGroupName | Skupina prostředků Azure odběratele Cíl partnera přidružený ke kanálu bude vytvořeno v rámci této skupiny prostředků. |
řetězec |
resourceMoveChangeHistory | Změna historie přesunu prostředku | ResourceMoveChangeHistory[] |
PartnerTopicInfo
ResourceMoveChangeHistory
Jméno | Popis | Hodnota |
---|---|---|
azureSubscriptionId | ID předplatného Azure prostředku | řetězec |
changedTimeUtc | Časové razítko UTC, kdy byl prostředek změněn. | řetězec |
resourceGroupName | Skupina prostředků Azure prostředku | řetězec |
WebhookPartnerDestinationInfo
Jméno | Popis | Hodnota |
---|---|---|
endpointType | Typ koncového bodu cíle partnera | WebHook (povinné) |
vlastnosti | Vlastnosti webhooku cílového cíle partnera | webhookPartnerDestinationProperties |
WebhookPartnerDestinationProperties
Jméno | Popis | Hodnota |
---|---|---|
clientAuthentication | Ověřování partnerského klienta | PartnerClientAuthentication |
endpointBaseUrl | Základní adresa URL, která představuje koncový bod cíle partnera. | řetězec |
endpointUrl | Adresa URL, která představuje koncový bod cíle partnera. | řetězec |
Definice prostředku Terraformu (poskytovatel AzAPI)
Typ prostředku partnerNamespaces/channels je možné nasadit s operacemi, které cílí:
- skupiny prostředků
Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.
Formát prostředku
Pokud chcete vytvořit prostředek Microsoft.EventGrid/partnerNamespaces/channels, přidejte do šablony následující Terraform.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.EventGrid/partnerNamespaces/channels@2023-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"
}
})
}
Objekty PartnerClientAuthentication
Nastavte clientAuthenticationType vlastnost určit typ objektu.
Pro AzureAD použijte:
{
clientAuthenticationType = "AzureAD"
properties = {
azureActiveDirectoryApplicationIdOrUri = "string"
azureActiveDirectoryTenantId = "string"
}
}
Objekty PartnerDestinationInfo
Nastavte vlastnost endpointType, která určuje typ objektu.
Pro webhookpoužijte:
{
endpointType = "WebHook"
properties = {
clientAuthentication = {
clientAuthenticationType = "string"
// For remaining properties, see PartnerClientAuthentication objects
}
endpointBaseUrl = "string"
endpointUrl = "string"
}
}
Hodnoty vlastností
AzureADPartnerClientAuthentication
Jméno | Popis | Hodnota |
---|---|---|
clientAuthenticationType | Typ ověřování klientů | AzureAD (povinné) |
vlastnosti | AzureAD ClientAuthentication – vlastnosti | azureADPartnerClientAuthenticationProperties |
AzureADPartnerClientAuthenticationProperties
Jméno | Popis | Hodnota |
---|---|---|
azureActiveDirectoryApplicationIdOrUri | ID aplikace Azure Active Directory nebo identifikátor URI pro získání přístupového tokenu, který bude zahrnut jako nosný token v žádostech o doručení. | řetězec |
azureActiveDirectoryTenantId | ID tenanta Azure Active Directory pro získání přístupového tokenu, který bude zahrnut jako nosný token v žádostech o doručení. | řetězec |
ChannelProperties
Jméno | Popis | Hodnota |
---|---|---|
channelType | Typ kanálu události, který představuje směr toku událostí. | PartnerDestination PartnerTopic |
expirationTimeIfNotActivatedUtc | Čas vypršení platnosti kanálu Pokud tento časovač vyprší, zatímco odpovídající téma partnera se nikdy neaktivuje, kanál a odpovídající téma partnera se odstraní. |
řetězec |
messageForActivation | Kontext nebo užitečná zpráva, kterou může odběratel použít během procesu schvalování. | řetězec |
partnerDestinationInfo | Tato vlastnost by měla být naplněna, když channelType je PartnerDestination a představuje informace o cílovém prostředku partnera odpovídajícímu kanálu. | PartnerDestinationInfo |
partnerTopicInfo | Tato vlastnost by měla být naplněna, pokud je typem channelType PartnerTopic a představuje informace o prostředku tématu partnera odpovídajícímu kanálu. | PartnerTopicInfo |
provisioningState | Stav zřizování kanálu | Zrušeno Vytváření Odstranění Chyba 'IdleDueToMirroredPartnerDestinationDeletion' 'IdleDueToMirroredPartnerTopicDeletion' Úspěch Aktualizace |
Stav připravenosti | Stav připravenosti odpovídajícího tématu partnera. | Aktivované NeverActivated |
EventTypeInfo
EventTypeInfoInlineEventTypes
Jméno | Popis | Hodnota |
---|
InlineEventProperties
Jméno | Popis | Hodnota |
---|---|---|
dataSchemaUrl | DataSchemaUrl pro vloženou událost. | řetězec |
popis | Popis vložené události. | řetězec |
displayName | DisplayName vložené události. | řetězec |
documentationUrl | DokumentaceUrl pro vloženou událost. | řetězec |
Microsoft.EventGrid/partnerNamespaces/channels
Jméno | Popis | Hodnota |
---|---|---|
Jméno | Název prostředku | string (povinné) |
parent_id | ID prostředku, který je nadřazený pro tento prostředek. | ID prostředku typu: partnerNamespaces |
vlastnosti | Vlastnosti kanálu. | |
typ | Typ prostředku | Microsoft.EventGrid/partnerNamespaces/channels@2023-12-15-preview |
PartnerClientAuthentication
Jméno | Popis | Hodnota |
---|---|---|
clientAuthenticationType | Pro typ AzureADPartnerClientAuthenticationnastavte hodnotu AzureAD . | AzureAD (povinné) |
PartnerDestinationInfo
Jméno | Popis | Hodnota |
---|---|---|
azureSubscriptionId | ID předplatného Azure odběratele Cíl partnera přidružený ke kanálu bude vytvořené v rámci tohoto předplatného Azure. |
řetězec |
endpointServiceContext | Další kontext cílového koncového bodu partnera | řetězec |
endpointType | Pro typ WebhookPartnerDestinationInfonastavte hodnotu WebHook. | WebHook (povinné) |
Jméno | Název cíle partnera přidruženého k kanálu | řetězec |
resourceGroupName | Skupina prostředků Azure odběratele Cíl partnera přidružený ke kanálu bude vytvořeno v rámci této skupiny prostředků. |
řetězec |
resourceMoveChangeHistory | Změna historie přesunu prostředku | ResourceMoveChangeHistory[] |
PartnerTopicInfo
ResourceMoveChangeHistory
Jméno | Popis | Hodnota |
---|---|---|
azureSubscriptionId | ID předplatného Azure prostředku | řetězec |
changedTimeUtc | Časové razítko UTC, kdy byl prostředek změněn. | řetězec |
resourceGroupName | Skupina prostředků Azure prostředku | řetězec |
WebhookPartnerDestinationInfo
Jméno | Popis | Hodnota |
---|---|---|
endpointType | Typ koncového bodu cíle partnera | WebHook (povinné) |
vlastnosti | Vlastnosti webhooku cílového cíle partnera | webhookPartnerDestinationProperties |
WebhookPartnerDestinationProperties
Jméno | Popis | Hodnota |
---|---|---|
clientAuthentication | Ověřování partnerského klienta | PartnerClientAuthentication |
endpointBaseUrl | Základní adresa URL, která představuje koncový bod cíle partnera. | řetězec |
endpointUrl | Adresa URL, která představuje koncový bod cíle partnera. | řetězec |