Namespaces Microsoft.EventGrid 2024-06-01-preview
Definição de recurso do Bicep
O tipo de recurso namespaces pode ser implantado com operações de destino:
- Grupos de recursos - Consulte comandos de implantação do grupo de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.
Formato de recurso
Para criar um recurso Microsoft.EventGrid/namespaces, adicione o Bicep a seguir ao seu modelo.
resource symbolicname 'Microsoft.EventGrid/namespaces@2024-06-01-preview' = {
identity: {
principalId: 'string'
tenantId: 'string'
type: 'string'
userAssignedIdentities: {
{customized property}: {
clientId: 'string'
principalId: 'string'
}
}
}
location: 'string'
name: 'string'
properties: {
inboundIpRules: [
{
action: 'string'
ipMask: 'string'
}
]
isZoneRedundant: bool
minimumTlsVersionAllowed: 'string'
privateEndpointConnections: [
{
properties: {
groupIds: [
'string'
]
privateEndpoint: {
id: 'string'
}
privateLinkServiceConnectionState: {
actionsRequired: 'string'
description: 'string'
status: 'string'
}
provisioningState: 'string'
}
}
]
publicNetworkAccess: 'string'
topicsConfiguration: {
customDomains: [
{
certificateUrl: 'string'
expectedTxtRecordName: 'string'
expectedTxtRecordValue: 'string'
fullyQualifiedDomainName: 'string'
identity: {
type: 'string'
userAssignedIdentity: 'string'
}
validationState: 'string'
}
]
}
topicSpacesConfiguration: {
clientAuthentication: {
alternativeAuthenticationNameSources: [
'string'
]
customJwtAuthentication: {
issuerCertificates: [
{
certificateUrl: 'string'
identity: {
type: 'string'
userAssignedIdentity: 'string'
}
}
]
tokenIssuer: 'string'
}
}
customDomains: [
{
certificateUrl: 'string'
expectedTxtRecordName: 'string'
expectedTxtRecordValue: 'string'
fullyQualifiedDomainName: 'string'
identity: {
type: 'string'
userAssignedIdentity: 'string'
}
validationState: 'string'
}
]
maximumClientSessionsPerAuthenticationName: int
maximumSessionExpiryInHours: int
routeTopicResourceId: 'string'
routingEnrichments: {
dynamic: [
{
key: 'string'
value: 'string'
}
]
static: [
{
key: 'string'
valueType: 'string'
// For remaining properties, see StaticRoutingEnrichment objects
}
]
}
routingIdentityInfo: {
type: 'string'
userAssignedIdentity: 'string'
}
state: 'string'
}
}
sku: {
capacity: int
name: 'string'
}
tags: {
{customized property}: 'string'
}
}
Objetos StaticRoutingEnrichment
Defina a propriedade valueType para especificar o tipo de objeto.
Para string, use:
{
value: 'string'
valueType: 'String'
}
Valores de propriedade
ClientAuthenticationSettings
Nome | Descrição | Valor |
---|---|---|
alternativeAuthenticationNameSources | Fontes de nome de autenticação alternativas relacionadas às configurações de autenticação do cliente para o recurso de namespace. | Matriz de cadeia de caracteres que contém qualquer um dos: 'ClientCertificateDns' 'ClientCertificateEmail' 'ClientCertificateIp' 'ClientCertificateSubject' 'ClientCertificateUri' |
customJwtAuthentication | Configurações de autenticação JWT personalizadas para o recurso de namespace. | CustomJwtAuthenticationSettings |
ConnectionState
Nome | Descrição | Valor |
---|---|---|
actionsRequired | Ações necessárias (se houver). | corda |
descrição | Descrição do estado da conexão. | corda |
estado | Status da conexão. | 'Aprovado' 'Desconectado' 'Pendente' 'Rejeitado' |
CustomDomainConfiguration
Nome | Descrição | Valor |
---|---|---|
certificateUrl | A URL do certificado usado para publicação no domínio personalizado. Atualmente, há suporte para certificados armazenados apenas no Azure Key Vault. Embora a URL do certificado possa ser URL com versão do seguinte formato https://{key-vault-name}.vault.azure.net/certificates/{certificate-name}/{version-id}, ou URL não inversa do seguinte formato (por exemplo, https://contosovault.vault.azure.net/certificates/contosocert, oferecemos suporte somente à URL de certificado não inversa (por exemplo, https://contosovault.vault.azure.net/certificates/contosocert) |
corda |
expectedTxtRecordName | Nome de registro TXT do DNS esperado. A Grade de Eventos verificará se há um registro TXT com esse nome no conjunto de registros DNS do nome de domínio personalizado para provar a propriedade sobre o domínio. Os valores nesse registro TXT devem conter o valor de registro TXT esperado. |
corda |
expectedTxtRecordValue | Valor de registro TXT de DNS esperado. A Grade de Eventos verificará um registro TXT com esse valor no conjunto de registros DNS do nome de domínio personalizado para provar a propriedade sobre o domínio. | corda |
fullyQualifiedDomainName | FQDN (Nome de Domínio Totalmente Qualificado) para o domínio personalizado. | cadeia de caracteres (obrigatório) |
identidade | Informações de identidade para acessar o certificado para o domínio personalizado. Essas informações de identidade devem corresponder a uma identidade que foi definida no namespace. | CustomDomainIdentity |
validationState | Estado de validação para o domínio personalizado. Esta é uma propriedade somente leitura e é inicialmente definida como 'Pendente' e será atualizada para 'Aprovado' pela Grade de Eventos somente depois que a propriedade do nome de domínio tiver sido validada com êxito. | 'Aprovado' 'ErrorRetrievingDnsRecord' 'Pendente' |
CustomDomainIdentity
Nome | Descrição | Valor |
---|---|---|
tipo | O tipo de identidade gerenciada usada. Pode ser 'SystemAssigned' ou 'UserAssigned'. | 'SystemAssigned' 'UserAssigned' |
userAssignedIdentity | A identidade do usuário associada ao recurso. | corda |
CustomJwtAuthenticationManagedIdentity
Nome | Descrição | Valor |
---|---|---|
tipo | O tipo de identidade gerenciada usada. Pode ser 'SystemAssigned' ou 'UserAssigned'. | 'SystemAssigned' 'UserAssigned' (obrigatório) |
userAssignedIdentity | A identidade do usuário associada ao recurso. | corda |
CustomJwtAuthenticationSettings
Nome | Descrição | Valor |
---|---|---|
issuerCertificates | Informações sobre o certificado usado para validação de token. Atualmente, há suporte para no máximo 2 certificados. | issuerCertificateInfo[] |
tokenIssuer | Emissor de token JWT esperado. | corda |
DynamicRoutingEnrichment
Nome | Descrição | Valor |
---|---|---|
chave | Chave de enriquecimento de roteamento dinâmico. | corda |
valor | Valor de enriquecimento de roteamento dinâmico. | corda |
IdentityInfo
Nome | Descrição | Valor |
---|---|---|
principalId | A ID principal da identidade do recurso. | corda |
tenantId | A ID do locatário do recurso. | corda |
tipo | O tipo de identidade gerenciada usada. O tipo 'SystemAssigned, UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá qualquer identidade. | 'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' |
userAssignedIdentities | A lista de identidades de usuário associadas ao recurso. As referências de chave do dicionário de identidade do usuário serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. No momento, essa propriedade não é usada e reservada para uso futuro. |
IdentityInfoUserAssignedIdentities |
IdentityInfoUserAssignedIdentities
Nome | Descrição | Valor |
---|
InboundIpRule
Nome | Descrição | Valor |
---|---|---|
ação | Ação a ser executada com base na correspondência ou nenhuma correspondência do IpMask. | 'Permitir' |
ipMask | Endereço IP na notação CIDR, por exemplo, 10.0.0.0/8. | corda |
IssuerCertificateInfo
Nome | Descrição | Valor |
---|---|---|
certificateUrl | URL do certificado Keyvault no formato https://keyvaultname.vault.azure.net/certificates/certificateName/certificateVersion. | cadeia de caracteres (obrigatório) |
identidade | A identidade que será usada para acessar o certificado. | CustomJwtAuthenticationManagedIdentity |
Microsoft.EventGrid/namespaces
Nome | Descrição | Valor |
---|---|---|
identidade | Informações de identidade para o recurso namespace. | IdentityInfo |
localização | Local do recurso. | cadeia de caracteres (obrigatório) |
nome | O nome do recurso | corda Restrições: Comprimento mínimo = 3 Comprimento máximo = 3 Padrão = ^[a-zA-Z0-9-]*$ (obrigatório) |
Propriedades | Propriedades do recurso namespace. | NamespaceProperties |
Sku | Representa os tipos de preço de SKU disponíveis. | namespaceSku |
Tags | Marcas de recurso | Dicionário de nomes e valores de marca. Consulte Marcas em modelos |
NamespaceProperties
NamespaceSku
Nome | Descrição | Valor |
---|---|---|
capacidade | Especifica o número de Unidades de Taxa de Transferência que define a capacidade do namespace. O valor padrão da propriedade é 1 que significa 1 Unidade de Taxa de Transferência = entrada de 1 MB/s e saída de 2 MB/s por namespace. A capacidade mínima é 1 e a capacidade máxima permitida é de 20. |
int |
nome | O nome da SKU. | 'Standard' |
PrivateEndpoint
Nome | Descrição | Valor |
---|---|---|
id | O identificador do ARM para o ponto de extremidade privado. | corda |
PrivateEndpointConnection
Nome | Descrição | Valor |
---|---|---|
Propriedades | Propriedades do PrivateEndpointConnection. | PrivateEndpointConnectionProperties |
PrivateEndpointConnectionProperties
Nome | Descrição | Valor |
---|---|---|
groupIds | GroupIds do recurso de serviço de link privado. | string[] |
privateEndpoint | O recurso de ponto de extremidade privado para esta conexão. | |
privateLinkServiceConnectionState | Detalhes sobre o estado da conexão. | |
provisioningState | Estado de provisionamento da Conexão de Ponto de Extremidade Privado. | 'Cancelado' 'Criando' 'Excluindo' 'Falha' 'Bem-sucedido' 'Atualizando' |
RoutingEnrichments
Nome | Descrição | Valor |
---|---|---|
dinâmico | DynamicRoutingEnrichment [] | |
estático | staticRoutingEnrichment[] |
RoutingIdentityInfo
Nome | Descrição | Valor |
---|---|---|
tipo | Tipo de identidade de roteamento para a configuração de espaços de tópico. | 'None' 'SystemAssigned' 'UserAssigned' |
userAssignedIdentity | corda |
StaticRoutingEnrichment
Nome | Descrição | Valor |
---|---|---|
chave | Chave de enriquecimento de roteamento estático. | corda |
valueType | Defina como 'String' para o tipo StaticStringRoutingEnrichment. | 'String' (obrigatório) |
StaticStringRoutingEnrichment
Nome | Descrição | Valor |
---|---|---|
valor | Valor de enriquecimento de roteamento de tipo de cadeia de caracteres. | corda |
valueType | Tipo de valor de enriquecimento de roteamento estático. Por exemplo, esse valor de propriedade pode ser 'String'. | 'String' (obrigatório) |
TopicsConfiguration
Nome | Descrição | Valor |
---|---|---|
customDomains | Lista de configurações de domínio personalizadas para o namespace. | CustomDomainConfiguration [] |
TopicSpacesConfiguration
Nome | Descrição | Valor |
---|---|---|
clientAuthentication | Configurações de autenticação do cliente para a configuração de espaços de tópico. | ClientAuthenticationSettings |
customDomains | Lista de configurações de domínio personalizadas para o namespace. | CustomDomainConfiguration [] |
maximumClientSessionsPerAuthenticationName | O número máximo de sessões por nome de autenticação. O valor padrão da propriedade é 1. O valor mínimo permitido é 1 e o valor máximo permitido é 100. |
int |
maximumSessionExpiryInHours | A expiração máxima da sessão em horas. O valor padrão da propriedade é de 1 hora. O valor mínimo permitido é de 1 hora e o valor máximo permitido é de 8 horas. |
int |
routeTopicResourceId | ID de Recurso do Azure totalmente qualificada para o Tópico da Grade de Eventos para o qual os eventos serão roteado a partir de TopicSpaces em um namespace. Essa propriedade deve estar no seguinte formato '/subscriptions/{subId}/resourcegroups/{resourceGroupName}/providers/microsoft. EventGrid/topics/{topicName}'. Este tópico deve residir na mesma região onde o namespace está localizado. |
corda |
routingEnrichments | Roteamento de enriquecimentos para configuração de espaços de tópico | RoutingEnrichments |
routingIdentityInfo | Informações de identidade de roteamento para a configuração de espaços de tópico. | RoutingIdentityInfo |
estado | Indique se a Configuração de Espaços de Tópico está habilitada para o namespace. O padrão é Desabilitado. | 'Desabilitado' 'Habilitado' |
TrackedResourceTags
Nome | Descrição | Valor |
---|
UserIdentityProperties
Nome | Descrição | Valor |
---|---|---|
clientId | A ID do cliente da identidade atribuída pelo usuário. | corda |
principalId | A ID principal da identidade atribuída pelo usuário. | corda |
Definição de recurso de modelo do ARM
O tipo de recurso namespaces pode ser implantado com operações de destino:
- Grupos de recursos - Consulte comandos de implantação do grupo de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.
Formato de recurso
Para criar um recurso Microsoft.EventGrid/namespaces, adicione o JSON a seguir ao modelo.
{
"type": "Microsoft.EventGrid/namespaces",
"apiVersion": "2024-06-01-preview",
"name": "string",
"identity": {
"principalId": "string",
"tenantId": "string",
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
"clientId": "string",
"principalId": "string"
}
}
},
"location": "string",
"properties": {
"inboundIpRules": [
{
"action": "string",
"ipMask": "string"
}
],
"isZoneRedundant": "bool",
"minimumTlsVersionAllowed": "string",
"privateEndpointConnections": [
{
"properties": {
"groupIds": [ "string" ],
"privateEndpoint": {
"id": "string"
},
"privateLinkServiceConnectionState": {
"actionsRequired": "string",
"description": "string",
"status": "string"
},
"provisioningState": "string"
}
}
],
"publicNetworkAccess": "string",
"topicsConfiguration": {
"customDomains": [
{
"certificateUrl": "string",
"expectedTxtRecordName": "string",
"expectedTxtRecordValue": "string",
"fullyQualifiedDomainName": "string",
"identity": {
"type": "string",
"userAssignedIdentity": "string"
},
"validationState": "string"
}
]
},
"topicSpacesConfiguration": {
"clientAuthentication": {
"alternativeAuthenticationNameSources": [ "string" ],
"customJwtAuthentication": {
"issuerCertificates": [
{
"certificateUrl": "string",
"identity": {
"type": "string",
"userAssignedIdentity": "string"
}
}
],
"tokenIssuer": "string"
}
},
"customDomains": [
{
"certificateUrl": "string",
"expectedTxtRecordName": "string",
"expectedTxtRecordValue": "string",
"fullyQualifiedDomainName": "string",
"identity": {
"type": "string",
"userAssignedIdentity": "string"
},
"validationState": "string"
}
],
"maximumClientSessionsPerAuthenticationName": "int",
"maximumSessionExpiryInHours": "int",
"routeTopicResourceId": "string",
"routingEnrichments": {
"dynamic": [
{
"key": "string",
"value": "string"
}
],
"static": [ {
"key": "string",
"valueType": "string"
// For remaining properties, see StaticRoutingEnrichment objects
} ]
},
"routingIdentityInfo": {
"type": "string",
"userAssignedIdentity": "string"
},
"state": "string"
}
},
"sku": {
"capacity": "int",
"name": "string"
},
"tags": {
"{customized property}": "string"
}
}
Objetos StaticRoutingEnrichment
Defina a propriedade valueType para especificar o tipo de objeto.
Para string, use:
{
"value": "string",
"valueType": "String"
}
Valores de propriedade
ClientAuthenticationSettings
Nome | Descrição | Valor |
---|---|---|
alternativeAuthenticationNameSources | Fontes de nome de autenticação alternativas relacionadas às configurações de autenticação do cliente para o recurso de namespace. | Matriz de cadeia de caracteres que contém qualquer um dos: 'ClientCertificateDns' 'ClientCertificateEmail' 'ClientCertificateIp' 'ClientCertificateSubject' 'ClientCertificateUri' |
customJwtAuthentication | Configurações de autenticação JWT personalizadas para o recurso de namespace. | CustomJwtAuthenticationSettings |
ConnectionState
Nome | Descrição | Valor |
---|---|---|
actionsRequired | Ações necessárias (se houver). | corda |
descrição | Descrição do estado da conexão. | corda |
estado | Status da conexão. | 'Aprovado' 'Desconectado' 'Pendente' 'Rejeitado' |
CustomDomainConfiguration
Nome | Descrição | Valor |
---|---|---|
certificateUrl | A URL do certificado usado para publicação no domínio personalizado. Atualmente, há suporte para certificados armazenados apenas no Azure Key Vault. Embora a URL do certificado possa ser URL com versão do seguinte formato https://{key-vault-name}.vault.azure.net/certificates/{certificate-name}/{version-id}, ou URL não inversa do seguinte formato (por exemplo, https://contosovault.vault.azure.net/certificates/contosocert, oferecemos suporte somente à URL de certificado não inversa (por exemplo, https://contosovault.vault.azure.net/certificates/contosocert) |
corda |
expectedTxtRecordName | Nome de registro TXT do DNS esperado. A Grade de Eventos verificará se há um registro TXT com esse nome no conjunto de registros DNS do nome de domínio personalizado para provar a propriedade sobre o domínio. Os valores nesse registro TXT devem conter o valor de registro TXT esperado. |
corda |
expectedTxtRecordValue | Valor de registro TXT de DNS esperado. A Grade de Eventos verificará um registro TXT com esse valor no conjunto de registros DNS do nome de domínio personalizado para provar a propriedade sobre o domínio. | corda |
fullyQualifiedDomainName | FQDN (Nome de Domínio Totalmente Qualificado) para o domínio personalizado. | cadeia de caracteres (obrigatório) |
identidade | Informações de identidade para acessar o certificado para o domínio personalizado. Essas informações de identidade devem corresponder a uma identidade que foi definida no namespace. | CustomDomainIdentity |
validationState | Estado de validação para o domínio personalizado. Esta é uma propriedade somente leitura e é inicialmente definida como 'Pendente' e será atualizada para 'Aprovado' pela Grade de Eventos somente depois que a propriedade do nome de domínio tiver sido validada com êxito. | 'Aprovado' 'ErrorRetrievingDnsRecord' 'Pendente' |
CustomDomainIdentity
Nome | Descrição | Valor |
---|---|---|
tipo | O tipo de identidade gerenciada usada. Pode ser 'SystemAssigned' ou 'UserAssigned'. | 'SystemAssigned' 'UserAssigned' |
userAssignedIdentity | A identidade do usuário associada ao recurso. | corda |
CustomJwtAuthenticationManagedIdentity
Nome | Descrição | Valor |
---|---|---|
tipo | O tipo de identidade gerenciada usada. Pode ser 'SystemAssigned' ou 'UserAssigned'. | 'SystemAssigned' 'UserAssigned' (obrigatório) |
userAssignedIdentity | A identidade do usuário associada ao recurso. | corda |
CustomJwtAuthenticationSettings
Nome | Descrição | Valor |
---|---|---|
issuerCertificates | Informações sobre o certificado usado para validação de token. Atualmente, há suporte para no máximo 2 certificados. | issuerCertificateInfo[] |
tokenIssuer | Emissor de token JWT esperado. | corda |
DynamicRoutingEnrichment
Nome | Descrição | Valor |
---|---|---|
chave | Chave de enriquecimento de roteamento dinâmico. | corda |
valor | Valor de enriquecimento de roteamento dinâmico. | corda |
IdentityInfo
Nome | Descrição | Valor |
---|---|---|
principalId | A ID principal da identidade do recurso. | corda |
tenantId | A ID do locatário do recurso. | corda |
tipo | O tipo de identidade gerenciada usada. O tipo 'SystemAssigned, UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá qualquer identidade. | 'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' |
userAssignedIdentities | A lista de identidades de usuário associadas ao recurso. As referências de chave do dicionário de identidade do usuário serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. No momento, essa propriedade não é usada e reservada para uso futuro. |
IdentityInfoUserAssignedIdentities |
IdentityInfoUserAssignedIdentities
Nome | Descrição | Valor |
---|
InboundIpRule
Nome | Descrição | Valor |
---|---|---|
ação | Ação a ser executada com base na correspondência ou nenhuma correspondência do IpMask. | 'Permitir' |
ipMask | Endereço IP na notação CIDR, por exemplo, 10.0.0.0/8. | corda |
IssuerCertificateInfo
Nome | Descrição | Valor |
---|---|---|
certificateUrl | URL do certificado Keyvault no formato https://keyvaultname.vault.azure.net/certificates/certificateName/certificateVersion. | cadeia de caracteres (obrigatório) |
identidade | A identidade que será usada para acessar o certificado. | CustomJwtAuthenticationManagedIdentity |
Microsoft.EventGrid/namespaces
Nome | Descrição | Valor |
---|---|---|
apiVersion | A versão da API | '2024-06-01-preview' |
identidade | Informações de identidade para o recurso namespace. | IdentityInfo |
localização | Local do recurso. | cadeia de caracteres (obrigatório) |
nome | O nome do recurso | corda Restrições: Comprimento mínimo = 3 Comprimento máximo = 3 Padrão = ^[a-zA-Z0-9-]*$ (obrigatório) |
Propriedades | Propriedades do recurso namespace. | NamespaceProperties |
Sku | Representa os tipos de preço de SKU disponíveis. | namespaceSku |
Tags | Marcas de recurso | Dicionário de nomes e valores de marca. Consulte Marcas em modelos |
tipo | O tipo de recurso | 'Microsoft.EventGrid/namespaces' |
NamespaceProperties
NamespaceSku
Nome | Descrição | Valor |
---|---|---|
capacidade | Especifica o número de Unidades de Taxa de Transferência que define a capacidade do namespace. O valor padrão da propriedade é 1 que significa 1 Unidade de Taxa de Transferência = entrada de 1 MB/s e saída de 2 MB/s por namespace. A capacidade mínima é 1 e a capacidade máxima permitida é de 20. |
int |
nome | O nome da SKU. | 'Standard' |
PrivateEndpoint
Nome | Descrição | Valor |
---|---|---|
id | O identificador do ARM para o ponto de extremidade privado. | corda |
PrivateEndpointConnection
Nome | Descrição | Valor |
---|---|---|
Propriedades | Propriedades do PrivateEndpointConnection. | PrivateEndpointConnectionProperties |
PrivateEndpointConnectionProperties
Nome | Descrição | Valor |
---|---|---|
groupIds | GroupIds do recurso de serviço de link privado. | string[] |
privateEndpoint | O recurso de ponto de extremidade privado para esta conexão. | |
privateLinkServiceConnectionState | Detalhes sobre o estado da conexão. | |
provisioningState | Estado de provisionamento da Conexão de Ponto de Extremidade Privado. | 'Cancelado' 'Criando' 'Excluindo' 'Falha' 'Bem-sucedido' 'Atualizando' |
RoutingEnrichments
Nome | Descrição | Valor |
---|---|---|
dinâmico | DynamicRoutingEnrichment [] | |
estático | staticRoutingEnrichment[] |
RoutingIdentityInfo
Nome | Descrição | Valor |
---|---|---|
tipo | Tipo de identidade de roteamento para a configuração de espaços de tópico. | 'None' 'SystemAssigned' 'UserAssigned' |
userAssignedIdentity | corda |
StaticRoutingEnrichment
Nome | Descrição | Valor |
---|---|---|
chave | Chave de enriquecimento de roteamento estático. | corda |
valueType | Defina como 'String' para o tipo StaticStringRoutingEnrichment. | 'String' (obrigatório) |
StaticStringRoutingEnrichment
Nome | Descrição | Valor |
---|---|---|
valor | Valor de enriquecimento de roteamento de tipo de cadeia de caracteres. | corda |
valueType | Tipo de valor de enriquecimento de roteamento estático. Por exemplo, esse valor de propriedade pode ser 'String'. | 'String' (obrigatório) |
TopicsConfiguration
Nome | Descrição | Valor |
---|---|---|
customDomains | Lista de configurações de domínio personalizadas para o namespace. | CustomDomainConfiguration [] |
TopicSpacesConfiguration
Nome | Descrição | Valor |
---|---|---|
clientAuthentication | Configurações de autenticação do cliente para a configuração de espaços de tópico. | ClientAuthenticationSettings |
customDomains | Lista de configurações de domínio personalizadas para o namespace. | CustomDomainConfiguration [] |
maximumClientSessionsPerAuthenticationName | O número máximo de sessões por nome de autenticação. O valor padrão da propriedade é 1. O valor mínimo permitido é 1 e o valor máximo permitido é 100. |
int |
maximumSessionExpiryInHours | A expiração máxima da sessão em horas. O valor padrão da propriedade é de 1 hora. O valor mínimo permitido é de 1 hora e o valor máximo permitido é de 8 horas. |
int |
routeTopicResourceId | ID de Recurso do Azure totalmente qualificada para o Tópico da Grade de Eventos para o qual os eventos serão roteado a partir de TopicSpaces em um namespace. Essa propriedade deve estar no seguinte formato '/subscriptions/{subId}/resourcegroups/{resourceGroupName}/providers/microsoft. EventGrid/topics/{topicName}'. Este tópico deve residir na mesma região onde o namespace está localizado. |
corda |
routingEnrichments | Roteamento de enriquecimentos para configuração de espaços de tópico | RoutingEnrichments |
routingIdentityInfo | Informações de identidade de roteamento para a configuração de espaços de tópico. | RoutingIdentityInfo |
estado | Indique se a Configuração de Espaços de Tópico está habilitada para o namespace. O padrão é Desabilitado. | 'Desabilitado' 'Habilitado' |
TrackedResourceTags
Nome | Descrição | Valor |
---|
UserIdentityProperties
Nome | Descrição | Valor |
---|---|---|
clientId | A ID do cliente da identidade atribuída pelo usuário. | corda |
principalId | A ID principal da identidade atribuída pelo usuário. | corda |
Definição de recurso do Terraform (provedor de AzAPI)
O tipo de recurso namespaces pode ser implantado com operações de destino:
- grupos de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.
Formato de recurso
Para criar um recurso Microsoft.EventGrid/namespaces, adicione o Terraform a seguir ao seu modelo.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.EventGrid/namespaces@2024-06-01-preview"
name = "string"
identity = {
principalId = "string"
tenantId = "string"
type = "string"
userAssignedIdentities = {
{customized property} = {
clientId = "string"
principalId = "string"
}
}
}
location = "string"
sku = {
capacity = int
name = "string"
}
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
inboundIpRules = [
{
action = "string"
ipMask = "string"
}
]
isZoneRedundant = bool
minimumTlsVersionAllowed = "string"
privateEndpointConnections = [
{
properties = {
groupIds = [
"string"
]
privateEndpoint = {
id = "string"
}
privateLinkServiceConnectionState = {
actionsRequired = "string"
description = "string"
status = "string"
}
provisioningState = "string"
}
}
]
publicNetworkAccess = "string"
topicsConfiguration = {
customDomains = [
{
certificateUrl = "string"
expectedTxtRecordName = "string"
expectedTxtRecordValue = "string"
fullyQualifiedDomainName = "string"
identity = {
type = "string"
userAssignedIdentity = "string"
}
validationState = "string"
}
]
}
topicSpacesConfiguration = {
clientAuthentication = {
alternativeAuthenticationNameSources = [
"string"
]
customJwtAuthentication = {
issuerCertificates = [
{
certificateUrl = "string"
identity = {
type = "string"
userAssignedIdentity = "string"
}
}
]
tokenIssuer = "string"
}
}
customDomains = [
{
certificateUrl = "string"
expectedTxtRecordName = "string"
expectedTxtRecordValue = "string"
fullyQualifiedDomainName = "string"
identity = {
type = "string"
userAssignedIdentity = "string"
}
validationState = "string"
}
]
maximumClientSessionsPerAuthenticationName = int
maximumSessionExpiryInHours = int
routeTopicResourceId = "string"
routingEnrichments = {
dynamic = [
{
key = "string"
value = "string"
}
]
static = [
{
key = "string"
valueType = "string"
// For remaining properties, see StaticRoutingEnrichment objects
}
]
}
routingIdentityInfo = {
type = "string"
userAssignedIdentity = "string"
}
state = "string"
}
}
})
}
Objetos StaticRoutingEnrichment
Defina a propriedade valueType para especificar o tipo de objeto.
Para string, use:
{
value = "string"
valueType = "String"
}
Valores de propriedade
ClientAuthenticationSettings
Nome | Descrição | Valor |
---|---|---|
alternativeAuthenticationNameSources | Fontes de nome de autenticação alternativas relacionadas às configurações de autenticação do cliente para o recurso de namespace. | Matriz de cadeia de caracteres que contém qualquer um dos: 'ClientCertificateDns' 'ClientCertificateEmail' 'ClientCertificateIp' 'ClientCertificateSubject' 'ClientCertificateUri' |
customJwtAuthentication | Configurações de autenticação JWT personalizadas para o recurso de namespace. | CustomJwtAuthenticationSettings |
ConnectionState
Nome | Descrição | Valor |
---|---|---|
actionsRequired | Ações necessárias (se houver). | corda |
descrição | Descrição do estado da conexão. | corda |
estado | Status da conexão. | 'Aprovado' 'Desconectado' 'Pendente' 'Rejeitado' |
CustomDomainConfiguration
Nome | Descrição | Valor |
---|---|---|
certificateUrl | A URL do certificado usado para publicação no domínio personalizado. Atualmente, há suporte para certificados armazenados apenas no Azure Key Vault. Embora a URL do certificado possa ser URL com versão do seguinte formato https://{key-vault-name}.vault.azure.net/certificates/{certificate-name}/{version-id}, ou URL não inversa do seguinte formato (por exemplo, https://contosovault.vault.azure.net/certificates/contosocert, oferecemos suporte somente à URL de certificado não inversa (por exemplo, https://contosovault.vault.azure.net/certificates/contosocert) |
corda |
expectedTxtRecordName | Nome de registro TXT do DNS esperado. A Grade de Eventos verificará se há um registro TXT com esse nome no conjunto de registros DNS do nome de domínio personalizado para provar a propriedade sobre o domínio. Os valores nesse registro TXT devem conter o valor de registro TXT esperado. |
corda |
expectedTxtRecordValue | Valor de registro TXT de DNS esperado. A Grade de Eventos verificará um registro TXT com esse valor no conjunto de registros DNS do nome de domínio personalizado para provar a propriedade sobre o domínio. | corda |
fullyQualifiedDomainName | FQDN (Nome de Domínio Totalmente Qualificado) para o domínio personalizado. | cadeia de caracteres (obrigatório) |
identidade | Informações de identidade para acessar o certificado para o domínio personalizado. Essas informações de identidade devem corresponder a uma identidade que foi definida no namespace. | CustomDomainIdentity |
validationState | Estado de validação para o domínio personalizado. Esta é uma propriedade somente leitura e é inicialmente definida como 'Pendente' e será atualizada para 'Aprovado' pela Grade de Eventos somente depois que a propriedade do nome de domínio tiver sido validada com êxito. | 'Aprovado' 'ErrorRetrievingDnsRecord' 'Pendente' |
CustomDomainIdentity
Nome | Descrição | Valor |
---|---|---|
tipo | O tipo de identidade gerenciada usada. Pode ser 'SystemAssigned' ou 'UserAssigned'. | 'SystemAssigned' 'UserAssigned' |
userAssignedIdentity | A identidade do usuário associada ao recurso. | corda |
CustomJwtAuthenticationManagedIdentity
Nome | Descrição | Valor |
---|---|---|
tipo | O tipo de identidade gerenciada usada. Pode ser 'SystemAssigned' ou 'UserAssigned'. | 'SystemAssigned' 'UserAssigned' (obrigatório) |
userAssignedIdentity | A identidade do usuário associada ao recurso. | corda |
CustomJwtAuthenticationSettings
Nome | Descrição | Valor |
---|---|---|
issuerCertificates | Informações sobre o certificado usado para validação de token. Atualmente, há suporte para no máximo 2 certificados. | issuerCertificateInfo[] |
tokenIssuer | Emissor de token JWT esperado. | corda |
DynamicRoutingEnrichment
Nome | Descrição | Valor |
---|---|---|
chave | Chave de enriquecimento de roteamento dinâmico. | corda |
valor | Valor de enriquecimento de roteamento dinâmico. | corda |
IdentityInfo
Nome | Descrição | Valor |
---|---|---|
principalId | A ID principal da identidade do recurso. | corda |
tenantId | A ID do locatário do recurso. | corda |
tipo | O tipo de identidade gerenciada usada. O tipo 'SystemAssigned, UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá qualquer identidade. | 'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' |
userAssignedIdentities | A lista de identidades de usuário associadas ao recurso. As referências de chave do dicionário de identidade do usuário serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. No momento, essa propriedade não é usada e reservada para uso futuro. |
IdentityInfoUserAssignedIdentities |
IdentityInfoUserAssignedIdentities
Nome | Descrição | Valor |
---|
InboundIpRule
Nome | Descrição | Valor |
---|---|---|
ação | Ação a ser executada com base na correspondência ou nenhuma correspondência do IpMask. | 'Permitir' |
ipMask | Endereço IP na notação CIDR, por exemplo, 10.0.0.0/8. | corda |
IssuerCertificateInfo
Nome | Descrição | Valor |
---|---|---|
certificateUrl | URL do certificado Keyvault no formato https://keyvaultname.vault.azure.net/certificates/certificateName/certificateVersion. | cadeia de caracteres (obrigatório) |
identidade | A identidade que será usada para acessar o certificado. | CustomJwtAuthenticationManagedIdentity |
Microsoft.EventGrid/namespaces
Nome | Descrição | Valor |
---|---|---|
identidade | Informações de identidade para o recurso namespace. | IdentityInfo |
localização | Local do recurso. | cadeia de caracteres (obrigatório) |
nome | O nome do recurso | corda Restrições: Comprimento mínimo = 3 Comprimento máximo = 3 Padrão = ^[a-zA-Z0-9-]*$ (obrigatório) |
Propriedades | Propriedades do recurso namespace. | NamespaceProperties |
Sku | Representa os tipos de preço de SKU disponíveis. | namespaceSku |
Tags | Marcas de recurso | Dicionário de nomes e valores de marca. |
tipo | O tipo de recurso | "Microsoft.EventGrid/namespaces@2024-06-01-preview" |
NamespaceProperties
NamespaceSku
Nome | Descrição | Valor |
---|---|---|
capacidade | Especifica o número de Unidades de Taxa de Transferência que define a capacidade do namespace. O valor padrão da propriedade é 1 que significa 1 Unidade de Taxa de Transferência = entrada de 1 MB/s e saída de 2 MB/s por namespace. A capacidade mínima é 1 e a capacidade máxima permitida é de 20. |
int |
nome | O nome da SKU. | 'Standard' |
PrivateEndpoint
Nome | Descrição | Valor |
---|---|---|
id | O identificador do ARM para o ponto de extremidade privado. | corda |
PrivateEndpointConnection
Nome | Descrição | Valor |
---|---|---|
Propriedades | Propriedades do PrivateEndpointConnection. | PrivateEndpointConnectionProperties |
PrivateEndpointConnectionProperties
Nome | Descrição | Valor |
---|---|---|
groupIds | GroupIds do recurso de serviço de link privado. | string[] |
privateEndpoint | O recurso de ponto de extremidade privado para esta conexão. | |
privateLinkServiceConnectionState | Detalhes sobre o estado da conexão. | |
provisioningState | Estado de provisionamento da Conexão de Ponto de Extremidade Privado. | 'Cancelado' 'Criando' 'Excluindo' 'Falha' 'Bem-sucedido' 'Atualizando' |
RoutingEnrichments
Nome | Descrição | Valor |
---|---|---|
dinâmico | DynamicRoutingEnrichment [] | |
estático | staticRoutingEnrichment[] |
RoutingIdentityInfo
Nome | Descrição | Valor |
---|---|---|
tipo | Tipo de identidade de roteamento para a configuração de espaços de tópico. | 'None' 'SystemAssigned' 'UserAssigned' |
userAssignedIdentity | corda |
StaticRoutingEnrichment
Nome | Descrição | Valor |
---|---|---|
chave | Chave de enriquecimento de roteamento estático. | corda |
valueType | Defina como 'String' para o tipo StaticStringRoutingEnrichment. | 'String' (obrigatório) |
StaticStringRoutingEnrichment
Nome | Descrição | Valor |
---|---|---|
valor | Valor de enriquecimento de roteamento de tipo de cadeia de caracteres. | corda |
valueType | Tipo de valor de enriquecimento de roteamento estático. Por exemplo, esse valor de propriedade pode ser 'String'. | 'String' (obrigatório) |
TopicsConfiguration
Nome | Descrição | Valor |
---|---|---|
customDomains | Lista de configurações de domínio personalizadas para o namespace. | CustomDomainConfiguration [] |
TopicSpacesConfiguration
Nome | Descrição | Valor |
---|---|---|
clientAuthentication | Configurações de autenticação do cliente para a configuração de espaços de tópico. | ClientAuthenticationSettings |
customDomains | Lista de configurações de domínio personalizadas para o namespace. | CustomDomainConfiguration [] |
maximumClientSessionsPerAuthenticationName | O número máximo de sessões por nome de autenticação. O valor padrão da propriedade é 1. O valor mínimo permitido é 1 e o valor máximo permitido é 100. |
int |
maximumSessionExpiryInHours | A expiração máxima da sessão em horas. O valor padrão da propriedade é de 1 hora. O valor mínimo permitido é de 1 hora e o valor máximo permitido é de 8 horas. |
int |
routeTopicResourceId | ID de Recurso do Azure totalmente qualificada para o Tópico da Grade de Eventos para o qual os eventos serão roteado a partir de TopicSpaces em um namespace. Essa propriedade deve estar no seguinte formato '/subscriptions/{subId}/resourcegroups/{resourceGroupName}/providers/microsoft. EventGrid/topics/{topicName}'. Este tópico deve residir na mesma região onde o namespace está localizado. |
corda |
routingEnrichments | Roteamento de enriquecimentos para configuração de espaços de tópico | RoutingEnrichments |
routingIdentityInfo | Informações de identidade de roteamento para a configuração de espaços de tópico. | RoutingIdentityInfo |
estado | Indique se a Configuração de Espaços de Tópico está habilitada para o namespace. O padrão é Desabilitado. | 'Desabilitado' 'Habilitado' |
TrackedResourceTags
Nome | Descrição | Valor |
---|
UserIdentityProperties
Nome | Descrição | Valor |
---|---|---|
clientId | A ID do cliente da identidade atribuída pelo usuário. | corda |
principalId | A ID principal da identidade atribuída pelo usuário. | corda |