Microsoft.ServiceBus/namespaces 2022-10-01-visualização - Bicep, ARM template & Terraform AzAPI reference

Definição de recursos do bíceps

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

Grupos de recursos - Consulte comandos de implantação de grupo 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.ServiceBus/namespaces, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.ServiceBus/namespaces@2022-10-01-preview' = {
  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

Designação	Descrição	Valor
Descrição	Descrição do estado da conexão.	string
Situação	Status da conexão.	'Aprovado' 'Desconectado' 'Pendente' 'Rejeitado'

Encriptação

Designação	Descrição	Valor
fonte-chave	Enumera o valor possível de keySource for Encryption	'Microsoft.KeyVault'
keyVaultPropriedades	Propriedades de KeyVault	KeyVaultProperties[]
requireInfrastructureEncryption	Habilitar criptografia de infraestrutura (criptografia dupla)	Bool

Identidade

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

IdentityUserAssignedIdentities

Designação	Descrição	Valor

KeyVaultProperties

Designação	Descrição	Valor
identidade		UserAssignedIdentityProperties
Nome da chave	Nome da chave do KeyVault	string
keyVaultUri	Uri do KeyVault	string
keyVersion [en]	Versão do KeyVault	string

Microsoft.ServiceBus/namespaces

Designação	Descrição	Valor
identidade	Descrição das propriedades da identidade BYOK	Identidade
Localização	A geolocalização onde o recurso vive	string (obrigatório)
Designação	O nome do recurso	string (obrigatório)
propriedades	Propriedades do namespace.	SBNamespaceProperties
SKU	Propriedades de SKU	SBSku
Etiquetas	Tags de recursos	Dicionário de nomes e valores de tags. Consulte Tags em modelos

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

SBNamespaceProperties

Designação	Descrição	Valor
alternateName	Nome alternativo para namespace	string
disableLocalAuth	Essa propriedade desabilita a autenticação SAS para o namespace do Service Bus.	Bool
encriptação	Descrição das propriedades da criptografia BYOK	Criptografia
minimumTlsVersion	A versão TLS mínima para o cluster suportar, por exemplo, '1.2'	'1.0' '1.1' '1.2'
premiumMessagingPartições	O número de partições de um namespace do Service Bus. Esta propriedade só é aplicável a namespaces Premium SKU. 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 privadas.	PrivateEndpointConnection []
publicNetworkAccess	Isso determina se o tráfego é permitido na rede pública. Por padrão, ele está habilitado.	'Desativado' 'Habilitado' 'SecuredByPerimeter'
zoneRedundante	A habilitação dessa propriedade cria um namespace do Barramento de Serviço Premium em regiões com suporte para zonas de disponibilidade.	Bool

SBSku

Designação	Descrição	Valor
capacidade	Unidades de mensagens para seu 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 são 4, 8, 16, 32 e 64	Int
Designação	Nome deste SKU.	'Básico' 'Premium' 'Standard' (obrigatório)
nível	O nível de faturamento dessa SKU específica.	'Básico' 'Premium' 'Padrão'

TrackedResourceTags

Designação	Descrição	Valor

UserAssignedIdentity

Designação	Descrição	Valor

UserAssignedIdentityProperties

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

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 Service Bus	Este modelo permite implantar um namespace Standard do Service Bus Standard e uma fila.
Criar um namespace do Service Bus de regra de Rede Virtual	Este modelo permite implantar um namespace Premium do Service Bus com a regra de Rede Virtual
Criar Tópico Personalizado da Grade de Eventos do Azure e de Assinatura de Fila	Cria um tópico personalizado da Grade de Eventos do Azure e uma assinatura de fila de barramento de serviço. Modelo originalmente de autoria de Markus Meyer.
Cria um aplicativo de microsserviços Dapr usando o Container Apps	Crie um aplicativo de microsserviços Dapr usando Aplicativos de Contêiner.
Cria um aplicativo de barramento de serviço pub-sub Dapr usando Aplicativos de Contêiner	Crie um aplicativo de barramento de serviço pub-sub Dapr usando Aplicativos de Contêiner.

Definição de recurso de modelo ARM

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

Grupos de recursos - Consulte comandos de implantação de grupo 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.ServiceBus/namespaces, adicione o seguinte JSON ao seu modelo.

{
  "type": "Microsoft.ServiceBus/namespaces",
  "apiVersion": "2022-10-01-preview",
  "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

Designação	Descrição	Valor
Descrição	Descrição do estado da conexão.	string
Situação	Status da conexão.	'Aprovado' 'Desconectado' 'Pendente' 'Rejeitado'

Encriptação

Designação	Descrição	Valor
fonte-chave	Enumera o valor possível de keySource for Encryption	'Microsoft.KeyVault'
keyVaultPropriedades	Propriedades de KeyVault	KeyVaultProperties[]
requireInfrastructureEncryption	Habilitar criptografia de infraestrutura (criptografia dupla)	Bool

Identidade

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

IdentityUserAssignedIdentities

Designação	Descrição	Valor

KeyVaultProperties

Designação	Descrição	Valor
identidade		UserAssignedIdentityProperties
Nome da chave	Nome da chave do KeyVault	string
keyVaultUri	Uri do KeyVault	string
keyVersion [en]	Versão do KeyVault	string

Microsoft.ServiceBus/namespaces

Designação	Descrição	Valor
apiVersion	A versão api	'2022-10-01-pré-visualização'
identidade	Descrição das propriedades da identidade BYOK	Identidade
Localização	A geolocalização onde o recurso vive	string (obrigatório)
Designação	O nome do recurso	string (obrigatório)
propriedades	Propriedades do namespace.	SBNamespaceProperties
SKU	Propriedades de SKU	SBSku
Etiquetas	Tags de recursos	Dicionário de nomes e valores de tags. Consulte Tags em modelos
tipo	O tipo de recurso	'Microsoft.ServiceBus/namespaces'

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

SBNamespaceProperties

Designação	Descrição	Valor
alternateName	Nome alternativo para namespace	string
disableLocalAuth	Essa propriedade desabilita a autenticação SAS para o namespace do Service Bus.	Bool
encriptação	Descrição das propriedades da criptografia BYOK	Criptografia
minimumTlsVersion	A versão TLS mínima para o cluster suportar, por exemplo, '1.2'	'1.0' '1.1' '1.2'
premiumMessagingPartições	O número de partições de um namespace do Service Bus. Esta propriedade só é aplicável a namespaces Premium SKU. 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 privadas.	PrivateEndpointConnection []
publicNetworkAccess	Isso determina se o tráfego é permitido na rede pública. Por padrão, ele está habilitado.	'Desativado' 'Habilitado' 'SecuredByPerimeter'
zoneRedundante	A habilitação dessa propriedade cria um namespace do Barramento de Serviço Premium em regiões com suporte para zonas de disponibilidade.	Bool

SBSku

Designação	Descrição	Valor
capacidade	Unidades de mensagens para seu 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 são 4, 8, 16, 32 e 64	Int
Designação	Nome deste SKU.	'Básico' 'Premium' 'Standard' (obrigatório)
nível	O nível de faturamento dessa SKU específica.	'Básico' 'Premium' 'Padrão'

TrackedResourceTags

Designação	Descrição	Valor

UserAssignedIdentity

Designação	Descrição	Valor

UserAssignedIdentityProperties

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

Modelos de início rápido

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

Modelo	Descrição
Conectar-se a um namespace do Service Bus por meio de de ponto de extremidade privado	Este exemplo mostra como usar configurar uma rede virtual e uma zona DNS privada para acessar um namespace do Service Bus por meio do ponto de extremidade privado.
Correlacionar mensagens em aplicativos lógicos usando o Service Bus	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 Service Bus	Este modelo permite configurar o alias de recuperação de desastres geográficos do Service Bus em namespaces SKU premium.
Criar um namespace do Service Bus	Este modelo permite implantar um namespace do Service Bus com uma SKU Básica/Padrão.
Criar um namespace e uma fila do Service Bus	Este modelo permite implantar um namespace Standard do Service Bus Standard e uma fila.
Criar um namespace do Service Bus e uma regra de autorização de fila	Esse modelo permite implantar um namespace do Service Bus Standard e regras de autorização para o namespace e uma fila.
Criar um namespace do Service Bus e um de tópicos	Este modelo cria um Namespace e um Tópico do Service Bus.
Regra Criar um Filtro IP de namespace do Service Bus	Este modelo permite implantar um namespace Premium do Service Bus com a regra de Filtro IP
Criar um namespace do Service Bus de regra de Rede Virtual	Este modelo permite implantar um namespace Premium do Service Bus com a regra de Rede Virtual
Criar um namespace, tópico e de assinatura do Service Bus	Este modelo permite implantar um namespace do Service Bus Standard, um tópico e uma assinatura.
Criar um namespace, tópico, assinatura e de regra do Service Bus	Este modelo permite implantar um namespace do Service Bus Standard, um tópico, uma assinatura e uma regra.
Criar um namespace Premium do Service Bus e um AuthorizationRule	Este modelo cria um Namespace Premium do Service Bus e um namespace AuthorizationRule
Criar um tópico do Service Bus com de assinatura e filtro SQL	Este modelo cria um Namespace e um Tópico do Service Bus com uma Assinatura usando uma expressão de Filtro SQL para receber somente as mensagens que correspondem à Expressão de Filtro SQL definida.
Criar Tópico Personalizado da Grade de Eventos do Azure e de Assinatura de Fila	Cria um tópico personalizado da Grade de Eventos do Azure e uma assinatura de fila de barramento de serviço. Modelo originalmente de autoria de Markus Meyer.
Criar de Subscrição de Tópico Personalizado da Grelha 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 de autoria de Markus Meyer.
Cria um aplicativo de microsserviços Dapr usando o Container Apps	Crie um aplicativo de microsserviços Dapr usando Aplicativos de Contêiner.
Cria um aplicativo de barramento de serviço pub-sub Dapr usando Aplicativos de Contêiner	Crie um aplicativo de barramento de serviço pub-sub Dapr usando Aplicativos de Contêiner.
EPiserverCMS no Azure	Este modelo permite que você crie os recursos necessários para a implantação do EpiServerCMS no Azure
Padrões de integração - Message Router - Service Bus	Solução que mostra como podemos configurar o padrão do Message Router usando um tópico do Service Bus

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ServiceBus/namespaces@2022-10-01-preview"
  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

Designação	Descrição	Valor
Descrição	Descrição do estado da conexão.	string
Situação	Status da conexão.	'Aprovado' 'Desconectado' 'Pendente' 'Rejeitado'

Encriptação

Designação	Descrição	Valor
fonte-chave	Enumera o valor possível de keySource for Encryption	'Microsoft.KeyVault'
keyVaultPropriedades	Propriedades de KeyVault	KeyVaultProperties[]
requireInfrastructureEncryption	Habilitar criptografia de infraestrutura (criptografia dupla)	Bool

Identidade

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

IdentityUserAssignedIdentities

Designação	Descrição	Valor

KeyVaultProperties

Designação	Descrição	Valor
identidade		UserAssignedIdentityProperties
Nome da chave	Nome da chave do KeyVault	string
keyVaultUri	Uri do KeyVault	string
keyVersion [en]	Versão do KeyVault	string

Microsoft.ServiceBus/namespaces

Designação	Descrição	Valor
identidade	Descrição das propriedades da identidade BYOK	Identidade
Localização	A geolocalização onde o recurso vive	string (obrigatório)
Designação	O nome do recurso	string (obrigatório)
propriedades	Propriedades do namespace.	SBNamespaceProperties
SKU	Propriedades de SKU	SBSku
Etiquetas	Tags de recursos	Dicionário de nomes e valores de tags.
tipo	O tipo de recurso	"Microsoft.ServiceBus/namespaces@2022-10-01-pré-visualizaçã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
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'

SBNamespaceProperties

Designação	Descrição	Valor
alternateName	Nome alternativo para namespace	string
disableLocalAuth	Essa propriedade desabilita a autenticação SAS para o namespace do Service Bus.	Bool
encriptação	Descrição das propriedades da criptografia BYOK	Criptografia
minimumTlsVersion	A versão TLS mínima para o cluster suportar, por exemplo, '1.2'	'1.0' '1.1' '1.2'
premiumMessagingPartições	O número de partições de um namespace do Service Bus. Esta propriedade só é aplicável a namespaces Premium SKU. 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 privadas.	PrivateEndpointConnection []
publicNetworkAccess	Isso determina se o tráfego é permitido na rede pública. Por padrão, ele está habilitado.	'Desativado' 'Habilitado' 'SecuredByPerimeter'
zoneRedundante	A habilitação dessa propriedade cria um namespace do Barramento de Serviço Premium em regiões com suporte para zonas de disponibilidade.	Bool

SBSku

Designação	Descrição	Valor
capacidade	Unidades de mensagens para seu 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 são 4, 8, 16, 32 e 64	Int
Designação	Nome deste SKU.	'Básico' 'Premium' 'Standard' (obrigatório)
nível	O nível de faturamento dessa SKU específica.	'Básico' 'Premium' 'Padrão'

TrackedResourceTags

Designação	Descrição	Valor

UserAssignedIdentity

Designação	Descrição	Valor

UserAssignedIdentityProperties

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

Partilhar via

Namespaces Microsoft.ServiceBus 2022-10-01-preview

Definição de recursos do bíceps

Formato do 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 ARM

Formato do 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 recursos Terraform (provedor AzAPI)

Formato do 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