Partilhar via

Namespaces Microsoft.EventGrid 2024-06-01-preview

  • Artigo

Definição de recursos do bíceps

O tipo de recurso namespaces pode ser implantado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.EventGrid/namespaces, adicione o seguinte Bicep 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'
  }
}

StaticRoutingEnriquecimento objetos

Defina a propriedade valueType para especificar o tipo de objeto.

Para String, use:

{
  value: 'string'
  valueType: 'String'
}

Valores de propriedade

ClientAuthenticationSettings

Designação 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 contendo qualquer uma das:
'ClientCertificateDns'
'ClientCertificateEmail'
'ClientCertificateIp'
'ClientCertificateSubject'
'ClientCertificateUri'
customJwtAuthentication Configurações de autenticação JWT personalizadas para o recurso de namespace. CustomJwtAuthenticationSettings

ConnectionState

Designação Descrição Valor
açõesObrigatório Ações necessárias (se houver). string
Descrição Descrição do estado da conexão. string
Situação Status da conexão. 'Aprovado'
'Desconectado'
'Pendente'
'Rejeitado'

CustomDomainConfiguration

Designação Descrição Valor
certificateUrl A URL do certificado usado para publicação no domínio personalizado. Atualmente, oferecemos suporte a certificados armazenados apenas no Azure Key Vault. Embora a URL do certificado possa ser
URL versionada do seguinte formato https://{key-vault-name}.vault.azure.net/certificates/{certificate-name}/{version-id} ou URL sem versão do seguinte formato (por exemplo,
https://contosovault.vault.azure.net/certificates/contosocert, suportamos apenas URL de certificado sem versão (por exemplo, https://contosovault.vault.azure.net/certificates/contosocert)		 string
expectedTxtRecordName Nome de registro TXT 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 sob este registro TXT devem conter o valor de registro TXT esperado.		 string
expectedTxtRecordValue Valor de registro TXT DNS esperado. A Grade de Eventos verificará se há 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. string
fullyQualifiedDomainName FQDN (nome de domínio totalmente qualificado) para o domínio personalizado. string (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 está 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

Designação 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. string

CustomJwtAuthenticationManagedIdentity

Designação 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. string

CustomJwtAuthenticationSettings

Designação Descrição Valor
emissorCertificados Informações sobre o certificado usado para validação de token. Atualmente, suportamos no máximo 2 certificados. IssuerCertificateInfo []
tokenEmissor Emissor de token JWT esperado. string

Enriquecimento DynamicRoutingEnriquecimento

Designação Descrição Valor
chave Chave de enriquecimento de roteamento dinâmico. string
valor Valor de enriquecimento de roteamento dinâmico. string

IdentityInfo

Designação Descrição Valor
principalId A ID principal da identidade do recurso. string
inquilinoId A ID do locatário do recurso. string
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 'Nenhum' removerá qualquer identidade. 'Nenhuma'
'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 ARM no formato:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
Esta propriedade não é usada no momento e está reservada para uso futuro.		 IdentityInfoUserAssignedIdentities

IdentityInfoUserAssignedIdentities

Designação Descrição Valor

InboundIpRule

Designação Descrição Valor
ação Ação a executar com base na correspondência ou não correspondência da IpMask. 'Permitir'
ipMask Endereço IP na notação CIDR, por exemplo, 10.0.0.0/8. string

EmissorCertificateInfo

Designação Descrição Valor
certificateUrl URL do certificado Keyvault em formato https://keyvaultname.vault.azure.net/certificates/certificateName/certificateVersion. string (obrigatório)
identidade A identidade que será usada para acessar o certificado. CustomJwtAuthenticationManagedIdentity

Microsoft.EventGrid/namespaces

Designação Descrição Valor
identidade Informações de identidade para o recurso Namespace. IdentityInfo
Localização Localização do recurso. string (obrigatório)
Designação O nome do recurso string

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 níveis de preços de Sku disponíveis. NamespaceSku
Etiquetas Tags de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos

NamespacePropriedades

Designação Descrição Valor
inboundIpRules Isso pode ser usado para restringir o tráfego de IPs específicos em vez de todos os IPs. Nota: Estes são considerados apenas se PublicNetworkAccess estiver ativado. InboundIpRule[]
isZoneRedundant Essa é uma propriedade opcional e permite que o usuário especifique se o recurso de namespace suporta a capacidade de redundância de zona ou não. Se esta seringa
propriedade não é especificada explicitamente pelo usuário, seu valor padrão depende das seguintes condições:
um. Para regiões habilitadas para Zonas de Disponibilidade - O valor da propriedade padrão seria true.
b. Para regiões habilitadas para zonas de não disponibilidade - O valor da propriedade padrão seria false.
Uma vez especificada, esta propriedade não pode ser atualizada.		 Bool
mínimoTlsVersionAllowed Versão TLS mínima do editor permitida para publicar neste namespace. Apenas a versão 1.2 do TLS é suportada. '1.0'
'1.1'
'1.2'
privateEndpointConnections Lista de conexões de ponto de extremidade privadas. PrivateEndpointConnection []
publicNetworkAccess Isso determina se o tráfego é permitido na rede pública. Por padrão, ele está habilitado.
Você pode restringir ainda mais a IPs específicos configurando <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.PubSub.NamespaceProperties.InboundIpRules" />		 'Desativado'
'Habilitado'
'SecuredByPerimeter'
tópicosConfiguração Tópicos: informações de configuração para o recurso de namespace Tópicos de configuração
topicSpacesConfiguration Informações de configuração de espaços de tópico para o recurso de namespace TopicSpacesConfiguration

NamespaceSku

Designação 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 1MB/s e saída de 2MB/s por namespace. A capacidade mínima é de 1 e
A capacidade máxima permitida é de 20.		 Int
Designação O nome do SKU. 'Padrão'

PrivateEndpoint

Designação Descrição Valor
ID O identificador ARM para Private Endpoint. string

PrivateEndpointConnection

Designação Descrição Valor
propriedades Propriedades do PrivateEndpointConnection. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Designação Descrição Valor
groupIds GroupIds do recurso de serviço de link privado. string[]
privateEndpoint O recurso Ponto Final Privado para esta Conexão. PrivateEndpoint
privateLinkServiceConnectionState Detalhes sobre o estado da conexão. ConnectionState
provisionamentoEstado Estado de provisionamento da Private Endpoint Connection. 'Cancelado'
'Criar'
'Eliminação'
'Falhou'
'Conseguiu'
'Atualização'

RoteamentoEnriquecimento

Designação Descrição Valor
dinâmico DynamicRoutingEnriquecimento[]
estática StaticRoutingEnriquecimento[]

RoutingIdentityInfo

Designação Descrição Valor
tipo Tipo de identidade de roteamento para configuração de espaços de tópico. 'Nenhuma'
'SystemAssigned'
'UserAssigned'
userAssignedIdentity string

EstáticaRoutingEnriquecimento

Designação Descrição Valor
chave Chave de enriquecimento de roteamento estático. string
valueType Defina como 'String' para o tipo StaticStringRoutingEnrichment. 'String' (obrigatório)

StaticStringRoutingEnriquecimento

Designação Descrição Valor
valor Valor de enriquecimento de roteamento do tipo de cadeia de caracteres. string
valueType Tipo de valor de enriquecimento de roteamento estático. Por exemplo, este valor de propriedade pode ser 'String'. 'String' (obrigatório)

TópicosConfiguração

Designação Descrição Valor
customDomains Lista de configurações de domínio personalizadas para o namespace. CustomDomainConfiguration []

TopicSpacesConfiguration

Designação Descrição Valor
clientAuthentication Configurações de autenticação de cliente para 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 é 1 hora.
O valor mínimo permitido é de 1 hora e o valor máximo permitido é de 8 horas.		 Int
routeTopicResourceId Id de Recursos do Azure totalmente qualificada para o Tópico da Grade de Eventos para o qual os eventos serão roteados de TopicSpaces em um namespace.
Esta 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.		 string
roteamentoEnriquecimento Enriquecimento de roteamento para configuração de espaços de tópico RoteamentoEnriquecimento
roteamentoIdentityInfo Informações de identidade de roteamento para 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 é Desativado. 'Desativado'
'Habilitado'

TrackedResourceTags

Designação Descrição Valor

UserIdentityProperties

Designação Descrição Valor
ID do cliente O ID do cliente da identidade atribuída ao usuário. string
principalId O id principal da identidade atribuída ao usuário. string

Definição de recurso de modelo ARM

O tipo de recurso namespaces pode ser implantado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.EventGrid/namespaces, adicione o seguinte JSON ao seu 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"
  }
}

StaticRoutingEnriquecimento objetos

Defina a propriedade valueType para especificar o tipo de objeto.

Para String, use:

{
  "value": "string",
  "valueType": "String"
}

Valores de propriedade

ClientAuthenticationSettings

Designação 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 contendo qualquer uma das:
'ClientCertificateDns'
'ClientCertificateEmail'
'ClientCertificateIp'
'ClientCertificateSubject'
'ClientCertificateUri'
customJwtAuthentication Configurações de autenticação JWT personalizadas para o recurso de namespace. CustomJwtAuthenticationSettings

ConnectionState

Designação Descrição Valor
açõesObrigatório Ações necessárias (se houver). string
Descrição Descrição do estado da conexão. string
Situação Status da conexão. 'Aprovado'
'Desconectado'
'Pendente'
'Rejeitado'

CustomDomainConfiguration

Designação Descrição Valor
certificateUrl A URL do certificado usado para publicação no domínio personalizado. Atualmente, oferecemos suporte a certificados armazenados apenas no Azure Key Vault. Embora a URL do certificado possa ser
URL versionada do seguinte formato https://{key-vault-name}.vault.azure.net/certificates/{certificate-name}/{version-id} ou URL sem versão do seguinte formato (por exemplo,
https://contosovault.vault.azure.net/certificates/contosocert, suportamos apenas URL de certificado sem versão (por exemplo, https://contosovault.vault.azure.net/certificates/contosocert)		 string
expectedTxtRecordName Nome de registro TXT 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 sob este registro TXT devem conter o valor de registro TXT esperado.		 string
expectedTxtRecordValue Valor de registro TXT DNS esperado. A Grade de Eventos verificará se há 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. string
fullyQualifiedDomainName FQDN (nome de domínio totalmente qualificado) para o domínio personalizado. string (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 está 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

Designação 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. string

CustomJwtAuthenticationManagedIdentity

Designação 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. string

CustomJwtAuthenticationSettings

Designação Descrição Valor
emissorCertificados Informações sobre o certificado usado para validação de token. Atualmente, suportamos no máximo 2 certificados. IssuerCertificateInfo []
tokenEmissor Emissor de token JWT esperado. string

Enriquecimento DynamicRoutingEnriquecimento

Designação Descrição Valor
chave Chave de enriquecimento de roteamento dinâmico. string
valor Valor de enriquecimento de roteamento dinâmico. string

IdentityInfo

Designação Descrição Valor
principalId A ID principal da identidade do recurso. string
inquilinoId A ID do locatário do recurso. string
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 'Nenhum' removerá qualquer identidade. 'Nenhuma'
'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 ARM no formato:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
Esta propriedade não é usada no momento e está reservada para uso futuro.		 IdentityInfoUserAssignedIdentities

IdentityInfoUserAssignedIdentities

Designação Descrição Valor

InboundIpRule

Designação Descrição Valor
ação Ação a executar com base na correspondência ou não correspondência da IpMask. 'Permitir'
ipMask Endereço IP na notação CIDR, por exemplo, 10.0.0.0/8. string

EmissorCertificateInfo

Designação Descrição Valor
certificateUrl URL do certificado Keyvault em formato https://keyvaultname.vault.azure.net/certificates/certificateName/certificateVersion. string (obrigatório)
identidade A identidade que será usada para acessar o certificado. CustomJwtAuthenticationManagedIdentity

Microsoft.EventGrid/namespaces

Designação Descrição Valor
apiVersion A versão api '2024-06-01-pré-visualização'
identidade Informações de identidade para o recurso Namespace. IdentityInfo
Localização Localização do recurso. string (obrigatório)
Designação O nome do recurso string

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 níveis de preços de Sku disponíveis. NamespaceSku
Etiquetas Tags de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos
tipo O tipo de recurso 'Microsoft.EventGrid/namespaces'

NamespacePropriedades

Designação Descrição Valor
inboundIpRules Isso pode ser usado para restringir o tráfego de IPs específicos em vez de todos os IPs. Nota: Estes são considerados apenas se PublicNetworkAccess estiver ativado. InboundIpRule[]
isZoneRedundant Essa é uma propriedade opcional e permite que o usuário especifique se o recurso de namespace suporta a capacidade de redundância de zona ou não. Se esta seringa
propriedade não é especificada explicitamente pelo usuário, seu valor padrão depende das seguintes condições:
um. Para regiões habilitadas para Zonas de Disponibilidade - O valor da propriedade padrão seria true.
b. Para regiões habilitadas para zonas de não disponibilidade - O valor da propriedade padrão seria false.
Uma vez especificada, esta propriedade não pode ser atualizada.		 Bool
mínimoTlsVersionAllowed Versão TLS mínima do editor permitida para publicar neste namespace. Apenas a versão 1.2 do TLS é suportada. '1.0'
'1.1'
'1.2'
privateEndpointConnections Lista de conexões de ponto de extremidade privadas. PrivateEndpointConnection []
publicNetworkAccess Isso determina se o tráfego é permitido na rede pública. Por padrão, ele está habilitado.
Você pode restringir ainda mais a IPs específicos configurando <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.PubSub.NamespaceProperties.InboundIpRules" />		 'Desativado'
'Habilitado'
'SecuredByPerimeter'
tópicosConfiguração Tópicos: informações de configuração para o recurso de namespace Tópicos de configuração
topicSpacesConfiguration Informações de configuração de espaços de tópico para o recurso de namespace TopicSpacesConfiguration

NamespaceSku

Designação 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 1MB/s e saída de 2MB/s por namespace. A capacidade mínima é de 1 e
A capacidade máxima permitida é de 20.		 Int
Designação O nome do SKU. 'Padrão'

PrivateEndpoint

Designação Descrição Valor
ID O identificador ARM para Private Endpoint. string

PrivateEndpointConnection

Designação Descrição Valor
propriedades Propriedades do PrivateEndpointConnection. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Designação Descrição Valor
groupIds GroupIds do recurso de serviço de link privado. string[]
privateEndpoint O recurso Ponto Final Privado para esta Conexão. PrivateEndpoint
privateLinkServiceConnectionState Detalhes sobre o estado da conexão. ConnectionState
provisionamentoEstado Estado de provisionamento da Private Endpoint Connection. 'Cancelado'
'Criar'
'Eliminação'
'Falhou'
'Conseguiu'
'Atualização'

RoteamentoEnriquecimento

Designação Descrição Valor
dinâmico DynamicRoutingEnriquecimento[]
estática StaticRoutingEnriquecimento[]

RoutingIdentityInfo

Designação Descrição Valor
tipo Tipo de identidade de roteamento para configuração de espaços de tópico. 'Nenhuma'
'SystemAssigned'
'UserAssigned'
userAssignedIdentity string

EstáticaRoutingEnriquecimento

Designação Descrição Valor
chave Chave de enriquecimento de roteamento estático. string
valueType Defina como 'String' para o tipo StaticStringRoutingEnrichment. 'String' (obrigatório)

StaticStringRoutingEnriquecimento

Designação Descrição Valor
valor Valor de enriquecimento de roteamento do tipo de cadeia de caracteres. string
valueType Tipo de valor de enriquecimento de roteamento estático. Por exemplo, este valor de propriedade pode ser 'String'. 'String' (obrigatório)

TópicosConfiguração

Designação Descrição Valor
customDomains Lista de configurações de domínio personalizadas para o namespace. CustomDomainConfiguration []

TopicSpacesConfiguration

Designação Descrição Valor
clientAuthentication Configurações de autenticação de cliente para 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 é 1 hora.
O valor mínimo permitido é de 1 hora e o valor máximo permitido é de 8 horas.		 Int
routeTopicResourceId Id de Recursos do Azure totalmente qualificada para o Tópico da Grade de Eventos para o qual os eventos serão roteados de TopicSpaces em um namespace.
Esta 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.		 string
roteamentoEnriquecimento Enriquecimento de roteamento para configuração de espaços de tópico RoteamentoEnriquecimento
roteamentoIdentityInfo Informações de identidade de roteamento para 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 é Desativado. 'Desativado'
'Habilitado'

TrackedResourceTags

Designação Descrição Valor

UserIdentityProperties

Designação Descrição Valor
ID do cliente O ID do cliente da identidade atribuída ao usuário. string
principalId O id principal da identidade atribuída ao usuário. string

Definição de recursos Terraform (provedor AzAPI)

O tipo de recurso namespaces pode ser implantado com operações que visam:

  • Grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.EventGrid/namespaces, adicione o seguinte Terraform 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"
      }
    }
  })
}

StaticRoutingEnriquecimento objetos

Defina a propriedade valueType para especificar o tipo de objeto.

Para String, use:

{
  value = "string"
  valueType = "String"
}

Valores de propriedade

ClientAuthenticationSettings

Designação 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 contendo qualquer uma das:
'ClientCertificateDns'
'ClientCertificateEmail'
'ClientCertificateIp'
'ClientCertificateSubject'
'ClientCertificateUri'
customJwtAuthentication Configurações de autenticação JWT personalizadas para o recurso de namespace. CustomJwtAuthenticationSettings

ConnectionState

Designação Descrição Valor
açõesObrigatório Ações necessárias (se houver). string
Descrição Descrição do estado da conexão. string
Situação Status da conexão. 'Aprovado'
'Desconectado'
'Pendente'
'Rejeitado'

CustomDomainConfiguration

Designação Descrição Valor
certificateUrl A URL do certificado usado para publicação no domínio personalizado. Atualmente, oferecemos suporte a certificados armazenados apenas no Azure Key Vault. Embora a URL do certificado possa ser
URL versionada do seguinte formato https://{key-vault-name}.vault.azure.net/certificates/{certificate-name}/{version-id} ou URL sem versão do seguinte formato (por exemplo,
https://contosovault.vault.azure.net/certificates/contosocert, suportamos apenas URL de certificado sem versão (por exemplo, https://contosovault.vault.azure.net/certificates/contosocert)		 string
expectedTxtRecordName Nome de registro TXT 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 sob este registro TXT devem conter o valor de registro TXT esperado.		 string
expectedTxtRecordValue Valor de registro TXT DNS esperado. A Grade de Eventos verificará se há 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. string
fullyQualifiedDomainName FQDN (nome de domínio totalmente qualificado) para o domínio personalizado. string (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 está 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

Designação 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. string

CustomJwtAuthenticationManagedIdentity

Designação 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. string

CustomJwtAuthenticationSettings

Designação Descrição Valor
emissorCertificados Informações sobre o certificado usado para validação de token. Atualmente, suportamos no máximo 2 certificados. IssuerCertificateInfo []
tokenEmissor Emissor de token JWT esperado. string

Enriquecimento DynamicRoutingEnriquecimento

Designação Descrição Valor
chave Chave de enriquecimento de roteamento dinâmico. string
valor Valor de enriquecimento de roteamento dinâmico. string

IdentityInfo

Designação Descrição Valor
principalId A ID principal da identidade do recurso. string
inquilinoId A ID do locatário do recurso. string
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 'Nenhum' removerá qualquer identidade. 'Nenhuma'
'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 ARM no formato:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
Esta propriedade não é usada no momento e está reservada para uso futuro.		 IdentityInfoUserAssignedIdentities

IdentityInfoUserAssignedIdentities

Designação Descrição Valor

InboundIpRule

Designação Descrição Valor
ação Ação a executar com base na correspondência ou não correspondência da IpMask. 'Permitir'
ipMask Endereço IP na notação CIDR, por exemplo, 10.0.0.0/8. string

EmissorCertificateInfo

Designação Descrição Valor
certificateUrl URL do certificado Keyvault em formato https://keyvaultname.vault.azure.net/certificates/certificateName/certificateVersion. string (obrigatório)
identidade A identidade que será usada para acessar o certificado. CustomJwtAuthenticationManagedIdentity

Microsoft.EventGrid/namespaces

Designação Descrição Valor
identidade Informações de identidade para o recurso Namespace. IdentityInfo
Localização Localização do recurso. string (obrigatório)
Designação O nome do recurso string

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 níveis de preços de Sku disponíveis. NamespaceSku
Etiquetas Tags de recursos Dicionário de nomes e valores de tags.
tipo O tipo de recurso "Microsoft.EventGrid/namespaces@2024-06-01-pré-visualização"

NamespacePropriedades

Designação Descrição Valor
inboundIpRules Isso pode ser usado para restringir o tráfego de IPs específicos em vez de todos os IPs. Nota: Estes são considerados apenas se PublicNetworkAccess estiver ativado. InboundIpRule[]
isZoneRedundant Essa é uma propriedade opcional e permite que o usuário especifique se o recurso de namespace suporta a capacidade de redundância de zona ou não. Se esta seringa
propriedade não é especificada explicitamente pelo usuário, seu valor padrão depende das seguintes condições:
um. Para regiões habilitadas para Zonas de Disponibilidade - O valor da propriedade padrão seria true.
b. Para regiões habilitadas para zonas de não disponibilidade - O valor da propriedade padrão seria false.
Uma vez especificada, esta propriedade não pode ser atualizada.		 Bool
mínimoTlsVersionAllowed Versão TLS mínima do editor permitida para publicar neste namespace. Apenas a versão 1.2 do TLS é suportada. '1.0'
'1.1'
'1.2'
privateEndpointConnections Lista de conexões de ponto de extremidade privadas. PrivateEndpointConnection []
publicNetworkAccess Isso determina se o tráfego é permitido na rede pública. Por padrão, ele está habilitado.
Você pode restringir ainda mais a IPs específicos configurando <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.PubSub.NamespaceProperties.InboundIpRules" />		 'Desativado'
'Habilitado'
'SecuredByPerimeter'
tópicosConfiguração Tópicos: informações de configuração para o recurso de namespace Tópicos de configuração
topicSpacesConfiguration Informações de configuração de espaços de tópico para o recurso de namespace TopicSpacesConfiguration

NamespaceSku

Designação 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 1MB/s e saída de 2MB/s por namespace. A capacidade mínima é de 1 e
A capacidade máxima permitida é de 20.		 Int
Designação O nome do SKU. 'Padrão'

PrivateEndpoint

Designação Descrição Valor
ID O identificador ARM para Private Endpoint. string

PrivateEndpointConnection

Designação Descrição Valor
propriedades Propriedades do PrivateEndpointConnection. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Designação Descrição Valor
groupIds GroupIds do recurso de serviço de link privado. string[]
privateEndpoint O recurso Ponto Final Privado para esta Conexão. PrivateEndpoint
privateLinkServiceConnectionState Detalhes sobre o estado da conexão. ConnectionState
provisionamentoEstado Estado de provisionamento da Private Endpoint Connection. 'Cancelado'
'Criar'
'Eliminação'
'Falhou'
'Conseguiu'
'Atualização'

RoteamentoEnriquecimento

Designação Descrição Valor
dinâmico DynamicRoutingEnriquecimento[]
estática StaticRoutingEnriquecimento[]

RoutingIdentityInfo

Designação Descrição Valor
tipo Tipo de identidade de roteamento para configuração de espaços de tópico. 'Nenhuma'
'SystemAssigned'
'UserAssigned'
userAssignedIdentity string

EstáticaRoutingEnriquecimento

Designação Descrição Valor
chave Chave de enriquecimento de roteamento estático. string
valueType Defina como 'String' para o tipo StaticStringRoutingEnrichment. 'String' (obrigatório)

StaticStringRoutingEnriquecimento

Designação Descrição Valor
valor Valor de enriquecimento de roteamento do tipo de cadeia de caracteres. string
valueType Tipo de valor de enriquecimento de roteamento estático. Por exemplo, este valor de propriedade pode ser 'String'. 'String' (obrigatório)

TópicosConfiguração

Designação Descrição Valor
customDomains Lista de configurações de domínio personalizadas para o namespace. CustomDomainConfiguration []

TopicSpacesConfiguration

Designação Descrição Valor
clientAuthentication Configurações de autenticação de cliente para 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 é 1 hora.
O valor mínimo permitido é de 1 hora e o valor máximo permitido é de 8 horas.		 Int
routeTopicResourceId Id de Recursos do Azure totalmente qualificada para o Tópico da Grade de Eventos para o qual os eventos serão roteados de TopicSpaces em um namespace.
Esta 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.		 string
roteamentoEnriquecimento Enriquecimento de roteamento para configuração de espaços de tópico RoteamentoEnriquecimento
roteamentoIdentityInfo Informações de identidade de roteamento para 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 é Desativado. 'Desativado'
'Habilitado'

TrackedResourceTags

Designação Descrição Valor

UserIdentityProperties

Designação Descrição Valor
ID do cliente O ID do cliente da identidade atribuída ao usuário. string
principalId O id principal da identidade atribuída ao usuário. string