Microsoft.ServiceBus/namespaces 2024-01-01 - Bicep, ARM template & Terraform AzAPI reference

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.ServiceBus/namespaces, adicione o Bicep a seguir ao seu modelo.

resource symbolicname 'Microsoft.ServiceBus/namespaces@2024-01-01' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    alternateName: 'string'
    disableLocalAuth: bool
    encryption: {
      keySource: 'Microsoft.KeyVault'
      keyVaultProperties: [
        {
          identity: {
            userAssignedIdentity: 'string'
          }
          keyName: 'string'
          keyVaultUri: 'string'
          keyVersion: 'string'
        }
      ]
      requireInfrastructureEncryption: bool
    }
    minimumTlsVersion: 'string'
    premiumMessagingPartitions: int
    privateEndpointConnections: [
      {
        properties: {
          privateEndpoint: {
            id: 'string'
          }
          privateLinkServiceConnectionState: {
            description: 'string'
            status: 'string'
          }
          provisioningState: 'string'
        }
      }
    ]
    publicNetworkAccess: 'string'
    zoneRedundant: bool
  }
  sku: {
    capacity: int
    name: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valores de propriedade

ConnectionState

Nome	Descrição	Valor
descrição	Descrição do estado da conexão.	corda
estado	Status da conexão.	'Aprovado' 'Desconectado' 'Pendente' 'Rejeitado'

Encriptação

Nome	Descrição	Valor
keySource	Enumera o valor possível de keySource for Encryption	'Microsoft.KeyVault'
keyVaultProperties	Propriedades do KeyVault	KeyVaultProperties[]
requireInfrastructureEncryption	Habilitar Criptografia de Infraestrutura (Criptografia Dupla)	Bool

Identidade

Nome	Descrição	Valor
tipo	Tipo de identidade de serviço gerenciado.	'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned'
userAssignedIdentities	Propriedades para identidades atribuídas pelo usuário	IdentityUserAssignedIdentities

IdentityUserAssignedIdentities

Nome	Descrição	Valor

KeyVaultProperties

Nome	Descrição	Valor
identidade		UserAssignedIdentityProperties
keyName	Nome da chave do KeyVault	corda
keyVaultUri	Uri de KeyVault	corda
keyVersion	Versão do KeyVault	corda

Microsoft.ServiceBus/namespaces

Nome	Descrição	Valor
identidade	Propriedades da descrição da identidade BYOK	Identity
localização	A localização geográfica onde o recurso reside	cadeia de caracteres (obrigatório)
nome	O nome do recurso	cadeia de caracteres (obrigatório)
Propriedades	Propriedades do namespace.	SBNamespaceProperties
Sku	Propriedades do SKU	do SBSku
Tags	Marcas de recurso	Dicionário de nomes e valores de marca. Consulte Marcas em modelos

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
privateEndpoint	O recurso de ponto de extremidade privado para esta conexão.	PrivateEndpoint
privateLinkServiceConnectionState	Detalhes sobre o estado da conexão.	ConnectionState
provisioningState	Estado de provisionamento da Conexão de Ponto de Extremidade Privado.	'Cancelado' 'Criando' 'Excluindo' 'Falha' 'Bem-sucedido' 'Atualizando'

SBNamespaceProperties

Nome	Descrição	Valor
alternateName	Nome alternativo para namespace	corda
disableLocalAuth	Essa propriedade desabilita a autenticação SAS para o namespace do Barramento de Serviço.	Bool
encriptação	Propriedades da descrição da Criptografia BYOK	Encryption
minimumTlsVersion	A versão mínima do TLS para o cluster dar suporte, por exemplo, '1.2'	'1.0' '1.1' '1.2'
premiumMessagingPartitions	O número de partições de um namespace do Barramento de Serviço. Essa propriedade só é aplicável aos namespaces de SKU Premium. O valor padrão é 1 e os valores possíveis são 1, 2 e 4	int
privateEndpointConnections	Lista de conexões de ponto de extremidade privado.	PrivateEndpointConnection []
publicNetworkAccess	Isso determina se o tráfego é permitido pela rede pública. Por padrão, ele está habilitado.	'Desabilitado' 'Habilitado' 'SecuredByPerimeter'
zoneRedundant	Habilitar essa propriedade cria um Namespace do Barramento de Serviço Premium em zonas de disponibilidade com suporte em regiões.	Bool

SBSku

Nome	Descrição	Valor
capacidade	Unidades de mensagens para o namespace premium do barramento de serviço. As capacidades válidas são {1, 2, 4, 8, 16} múltiplos da configuração properties.premiumMessagingPartitions. Por exemplo, se properties.premiumMessagingPartitions for 1, os valores de capacidade possíveis serão 1, 2, 4, 8 e 16. Se properties.premiumMessagingPartitions for 4, os valores de capacidade possíveis serão 4, 8, 16, 32 e 64	int
nome	Nome dessa SKU.	'Básico' 'Premium' 'Standard' (obrigatório)
camada	A camada de cobrança deste SKU específico.	'Básico' 'Premium' 'Standard'

TrackedResourceTags

Nome	Descrição	Valor

UserAssignedIdentity

Nome	Descrição	Valor

UserAssignedIdentityProperties

Nome	Descrição	Valor
userAssignedIdentity	ID do ARM da identidade do usuário selecionada para criptografia	corda

Exemplos de início rápido

Os exemplos de início rápido a seguir implantam esse tipo de recurso.

Arquivo Bicep	Descrição
criar um namespace e uma fila do Barramento de Serviço	Esse modelo permite implantar um namespace Standard do Barramento de Serviço e uma fila.
Criar uma regra de Rede Virtual do namespace do Barramento de Serviço	Este modelo permite implantar um namespace Premium do Barramento de Serviço com a regra de Rede Virtual
criar o tópico personalizado da Grade de Eventos do Azure e a assinatura da fila	Cria um tópico personalizado da Grade de Eventos do Azure e uma assinatura de fila do barramento de serviço. Modelo originalmente criado por Markus Meyer.
cria um aplicativo de microsserviços da Dapr usando aplicativos de contêiner	Crie um aplicativo de microsserviços Dapr usando Aplicativos de Contêiner.
Cria um aplicativo dapr pub-sub servicebus usando aplicativos de contêiner	Crie um aplicativo dapr pub-sub servicebus usando Aplicativos de Contêiner.

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.ServiceBus/namespaces, adicione o JSON a seguir ao modelo.

{
  "type": "Microsoft.ServiceBus/namespaces",
  "apiVersion": "2024-01-01",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "alternateName": "string",
    "disableLocalAuth": "bool",
    "encryption": {
      "keySource": "Microsoft.KeyVault",
      "keyVaultProperties": [
        {
          "identity": {
            "userAssignedIdentity": "string"
          },
          "keyName": "string",
          "keyVaultUri": "string",
          "keyVersion": "string"
        }
      ],
      "requireInfrastructureEncryption": "bool"
    },
    "minimumTlsVersion": "string",
    "premiumMessagingPartitions": "int",
    "privateEndpointConnections": [
      {
        "properties": {
          "privateEndpoint": {
            "id": "string"
          },
          "privateLinkServiceConnectionState": {
            "description": "string",
            "status": "string"
          },
          "provisioningState": "string"
        }
      }
    ],
    "publicNetworkAccess": "string",
    "zoneRedundant": "bool"
  },
  "sku": {
    "capacity": "int",
    "name": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valores de propriedade

ConnectionState

Nome	Descrição	Valor
descrição	Descrição do estado da conexão.	corda
estado	Status da conexão.	'Aprovado' 'Desconectado' 'Pendente' 'Rejeitado'

Encriptação

Nome	Descrição	Valor
keySource	Enumera o valor possível de keySource for Encryption	'Microsoft.KeyVault'
keyVaultProperties	Propriedades do KeyVault	KeyVaultProperties[]
requireInfrastructureEncryption	Habilitar Criptografia de Infraestrutura (Criptografia Dupla)	Bool

Identidade

Nome	Descrição	Valor
tipo	Tipo de identidade de serviço gerenciado.	'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned'
userAssignedIdentities	Propriedades para identidades atribuídas pelo usuário	IdentityUserAssignedIdentities

IdentityUserAssignedIdentities

Nome	Descrição	Valor

KeyVaultProperties

Nome	Descrição	Valor
identidade		UserAssignedIdentityProperties
keyName	Nome da chave do KeyVault	corda
keyVaultUri	Uri de KeyVault	corda
keyVersion	Versão do KeyVault	corda

Microsoft.ServiceBus/namespaces

Nome	Descrição	Valor
apiVersion	A versão da API	'2024-01-01'
identidade	Propriedades da descrição da identidade BYOK	Identity
localização	A localização geográfica onde o recurso reside	cadeia de caracteres (obrigatório)
nome	O nome do recurso	cadeia de caracteres (obrigatório)
Propriedades	Propriedades do namespace.	SBNamespaceProperties
Sku	Propriedades do SKU	do SBSku
Tags	Marcas de recurso	Dicionário de nomes e valores de marca. Consulte Marcas em modelos
tipo	O tipo de recurso	'Microsoft.ServiceBus/namespaces'

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
privateEndpoint	O recurso de ponto de extremidade privado para esta conexão.	PrivateEndpoint
privateLinkServiceConnectionState	Detalhes sobre o estado da conexão.	ConnectionState
provisioningState	Estado de provisionamento da Conexão de Ponto de Extremidade Privado.	'Cancelado' 'Criando' 'Excluindo' 'Falha' 'Bem-sucedido' 'Atualizando'

SBNamespaceProperties

Nome	Descrição	Valor
alternateName	Nome alternativo para namespace	corda
disableLocalAuth	Essa propriedade desabilita a autenticação SAS para o namespace do Barramento de Serviço.	Bool
encriptação	Propriedades da descrição da Criptografia BYOK	Encryption
minimumTlsVersion	A versão mínima do TLS para o cluster dar suporte, por exemplo, '1.2'	'1.0' '1.1' '1.2'
premiumMessagingPartitions	O número de partições de um namespace do Barramento de Serviço. Essa propriedade só é aplicável aos namespaces de SKU Premium. O valor padrão é 1 e os valores possíveis são 1, 2 e 4	int
privateEndpointConnections	Lista de conexões de ponto de extremidade privado.	PrivateEndpointConnection []
publicNetworkAccess	Isso determina se o tráfego é permitido pela rede pública. Por padrão, ele está habilitado.	'Desabilitado' 'Habilitado' 'SecuredByPerimeter'
zoneRedundant	Habilitar essa propriedade cria um Namespace do Barramento de Serviço Premium em zonas de disponibilidade com suporte em regiões.	Bool

SBSku

Nome	Descrição	Valor
capacidade	Unidades de mensagens para o namespace premium do barramento de serviço. As capacidades válidas são {1, 2, 4, 8, 16} múltiplos da configuração properties.premiumMessagingPartitions. Por exemplo, se properties.premiumMessagingPartitions for 1, os valores de capacidade possíveis serão 1, 2, 4, 8 e 16. Se properties.premiumMessagingPartitions for 4, os valores de capacidade possíveis serão 4, 8, 16, 32 e 64	int
nome	Nome dessa SKU.	'Básico' 'Premium' 'Standard' (obrigatório)
camada	A camada de cobrança deste SKU específico.	'Básico' 'Premium' 'Standard'

TrackedResourceTags

Nome	Descrição	Valor

UserAssignedIdentity

Nome	Descrição	Valor

UserAssignedIdentityProperties

Nome	Descrição	Valor
userAssignedIdentity	ID do ARM da identidade do usuário selecionada para criptografia	corda

Modelos de início rápido

Os modelos de início rápido a seguir implantam esse tipo de recurso.

Modelo	Descrição
Conectar a um namespace do Barramento de Serviço por meio de de ponto de extremidade privado	Este exemplo mostra como usar a configuração de uma rede virtual e uma zona DNS privada para acessar um namespace do Barramento de Serviço por meio do ponto de extremidade privado.
correlacionar mensagens em aplicativos lógicos usando do Barramento de Serviço	que mostra como podemos correlacionar mensagens em aplicativos lógicos usando o Barramento de Serviço do Azure
criar um de recuperação geográfica do Barramento de Serviço	Esse modelo permite que você configure o alias de recuperação de desastre geográfico do Barramento de Serviço em namespaces de SKU premium.
criar um namespace do Barramento de Serviço	Esse modelo permite implantar um namespace do Barramento de Serviço com um SKU Básico/Standard.
criar um namespace e uma fila do Barramento de Serviço	Esse modelo permite implantar um namespace Standard do Barramento de Serviço e uma fila.
Criar um namespace do Barramento de Serviço e uma regra de autorização de fila	Esse modelo permite implantar um namespace Standard do Barramento de Serviço e regras de autorização para o namespace e uma fila.
criar um namespace e um tópico do Barramento de Serviço	Este modelo cria um namespace e um tópico do Barramento de Serviço.
criar uma regra de filtro IP do namespace do Barramento de Serviço	Este modelo permite implantar um namespace Premium do Barramento de Serviço com a regra filtro IP
Criar uma regra de Rede Virtual do namespace do Barramento de Serviço	Este modelo permite implantar um namespace Premium do Barramento de Serviço com a regra de Rede Virtual
Criar um namespace, um tópico e uma assinatura do Barramento de Serviço	Esse modelo permite implantar um namespace standard do Barramento de Serviço, um tópico e uma assinatura.
Criar um namespace, tópico, assinatura e regra do Barramento de Serviço	Esse modelo permite implantar um namespace Standard do Barramento de Serviço, um tópico, uma assinatura e uma regra.
criar um namespace premium do Barramento de Serviço e o AuthorizationRule	Este modelo cria um namespace Premium do Barramento de Serviço e um Namespace AuthorizationRule
criar um tópico do Barramento de Serviço com assinatura e filtro SQL	Este modelo cria um Namespace e Um Tópico do Barramento de Serviço com uma Assinatura usando uma expressão de Filtro SQL para receber apenas as mensagens que correspondem à expressão de filtro SQL definida.
criar o tópico personalizado da Grade de Eventos do Azure e a assinatura da fila	Cria um tópico personalizado da Grade de Eventos do Azure e uma assinatura de fila do barramento de serviço. Modelo originalmente criado por Markus Meyer.
criar assinatura de tópico personalizado da Grade de Eventos do Azure	Cria um tópico personalizado da Grade de Eventos do Azure e uma assinatura de tópico do barramento de serviço. Modelo originalmente criado por Markus Meyer.
cria um aplicativo de microsserviços da Dapr usando aplicativos de contêiner	Crie um aplicativo de microsserviços Dapr usando Aplicativos de Contêiner.
Cria um aplicativo dapr pub-sub servicebus usando aplicativos de contêiner	Crie um aplicativo dapr pub-sub servicebus usando Aplicativos de Contêiner.
EPiserverCMS no Azure	Esse modelo permite que você crie recursos necessários para a implantação do EpiServerCMS no Azure
Padrões de integração – Roteador de Mensagens – Barramento de Serviço	Solução que mostra como podemos configurar o padrão roteador de mensagem usando um tópico do Barramento de Serviço

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.ServiceBus/namespaces, adicione o Terraform a seguir ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ServiceBus/namespaces@2024-01-01"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  sku = {
    capacity = int
    name = "string"
    tier = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      alternateName = "string"
      disableLocalAuth = bool
      encryption = {
        keySource = "Microsoft.KeyVault"
        keyVaultProperties = [
          {
            identity = {
              userAssignedIdentity = "string"
            }
            keyName = "string"
            keyVaultUri = "string"
            keyVersion = "string"
          }
        ]
        requireInfrastructureEncryption = bool
      }
      minimumTlsVersion = "string"
      premiumMessagingPartitions = int
      privateEndpointConnections = [
        {
          properties = {
            privateEndpoint = {
              id = "string"
            }
            privateLinkServiceConnectionState = {
              description = "string"
              status = "string"
            }
            provisioningState = "string"
          }
        }
      ]
      publicNetworkAccess = "string"
      zoneRedundant = bool
    }
  })
}

Valores de propriedade

ConnectionState

Nome	Descrição	Valor
descrição	Descrição do estado da conexão.	corda
estado	Status da conexão.	'Aprovado' 'Desconectado' 'Pendente' 'Rejeitado'

Encriptação

Nome	Descrição	Valor
keySource	Enumera o valor possível de keySource for Encryption	'Microsoft.KeyVault'
keyVaultProperties	Propriedades do KeyVault	KeyVaultProperties[]
requireInfrastructureEncryption	Habilitar Criptografia de Infraestrutura (Criptografia Dupla)	Bool

Identidade

Nome	Descrição	Valor
tipo	Tipo de identidade de serviço gerenciado.	'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned'
userAssignedIdentities	Propriedades para identidades atribuídas pelo usuário	IdentityUserAssignedIdentities

IdentityUserAssignedIdentities

Nome	Descrição	Valor

KeyVaultProperties

Nome	Descrição	Valor
identidade		UserAssignedIdentityProperties
keyName	Nome da chave do KeyVault	corda
keyVaultUri	Uri de KeyVault	corda
keyVersion	Versão do KeyVault	corda

Microsoft.ServiceBus/namespaces

Nome	Descrição	Valor
identidade	Propriedades da descrição da identidade BYOK	Identity
localização	A localização geográfica onde o recurso reside	cadeia de caracteres (obrigatório)
nome	O nome do recurso	cadeia de caracteres (obrigatório)
Propriedades	Propriedades do namespace.	SBNamespaceProperties
Sku	Propriedades do SKU	do SBSku
Tags	Marcas de recurso	Dicionário de nomes e valores de marca.
tipo	O tipo de recurso	"Microsoft.ServiceBus/namespaces@2024-01-01"

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
privateEndpoint	O recurso de ponto de extremidade privado para esta conexão.	PrivateEndpoint
privateLinkServiceConnectionState	Detalhes sobre o estado da conexão.	ConnectionState
provisioningState	Estado de provisionamento da Conexão de Ponto de Extremidade Privado.	'Cancelado' 'Criando' 'Excluindo' 'Falha' 'Bem-sucedido' 'Atualizando'

SBNamespaceProperties

Nome	Descrição	Valor
alternateName	Nome alternativo para namespace	corda
disableLocalAuth	Essa propriedade desabilita a autenticação SAS para o namespace do Barramento de Serviço.	Bool
encriptação	Propriedades da descrição da Criptografia BYOK	Encryption
minimumTlsVersion	A versão mínima do TLS para o cluster dar suporte, por exemplo, '1.2'	'1.0' '1.1' '1.2'
premiumMessagingPartitions	O número de partições de um namespace do Barramento de Serviço. Essa propriedade só é aplicável aos namespaces de SKU Premium. O valor padrão é 1 e os valores possíveis são 1, 2 e 4	int
privateEndpointConnections	Lista de conexões de ponto de extremidade privado.	PrivateEndpointConnection []
publicNetworkAccess	Isso determina se o tráfego é permitido pela rede pública. Por padrão, ele está habilitado.	'Desabilitado' 'Habilitado' 'SecuredByPerimeter'
zoneRedundant	Habilitar essa propriedade cria um Namespace do Barramento de Serviço Premium em zonas de disponibilidade com suporte em regiões.	Bool

SBSku

Nome	Descrição	Valor
capacidade	Unidades de mensagens para o namespace premium do barramento de serviço. As capacidades válidas são {1, 2, 4, 8, 16} múltiplos da configuração properties.premiumMessagingPartitions. Por exemplo, se properties.premiumMessagingPartitions for 1, os valores de capacidade possíveis serão 1, 2, 4, 8 e 16. Se properties.premiumMessagingPartitions for 4, os valores de capacidade possíveis serão 4, 8, 16, 32 e 64	int
nome	Nome dessa SKU.	'Básico' 'Premium' 'Standard' (obrigatório)
camada	A camada de cobrança deste SKU específico.	'Básico' 'Premium' 'Standard'

TrackedResourceTags

Nome	Descrição	Valor

UserAssignedIdentity

Nome	Descrição	Valor

UserAssignedIdentityProperties

Nome	Descrição	Valor
userAssignedIdentity	ID do ARM da identidade do usuário selecionada para criptografia	corda

Compartilhar via

Namespaces do Microsoft.ServiceBus 2024-01-01

Definição de recurso do Bicep

Formato de recurso

Valores de propriedade

ConnectionState

Encriptação

Identidade

IdentityUserAssignedIdentities

KeyVaultProperties

Microsoft.ServiceBus/namespaces

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

SBNamespaceProperties

SBSku

TrackedResourceTags

UserAssignedIdentity

UserAssignedIdentityProperties

Exemplos de início rápido

Definição de recurso de modelo do ARM

Formato de recurso

Valores de propriedade

ConnectionState

Encriptação

Identidade

IdentityUserAssignedIdentities

KeyVaultProperties

Microsoft.ServiceBus/namespaces

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

SBNamespaceProperties

SBSku

TrackedResourceTags

UserAssignedIdentity

UserAssignedIdentityProperties

Modelos de início rápido

Definição de recurso do Terraform (provedor de AzAPI)

Formato de recurso

Valores de propriedade

ConnectionState

Encriptação

Identidade

IdentityUserAssignedIdentities

KeyVaultProperties

Microsoft.ServiceBus/namespaces

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

SBNamespaceProperties

SBSku

TrackedResourceTags

UserAssignedIdentity

UserAssignedIdentityProperties

Comentários

Recursos adicionais