Microsoft.ServiceBus przestrzenie nazw/kolejki 2024-01-01

• najnowsze
• 2024-01-01
• 2023-01-01-preview
• 2022-10-01-preview
• 2022-01-01-preview
• 2021-11-01
• 2021-06-01-preview
• 2021-01-01-preview
• 2018-01-01-preview
• 2017-04-01
• 2015-08-01

Definicja zasobu Bicep

Typ zasobu przestrzeni nazw/kolejek można wdrożyć przy użyciu operacji docelowych:

• grupy zasobów — zobacz polecenia wdrażania grupy zasobów

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.ServiceBus/namespaces/queues, dodaj następujący kod Bicep do szablonu.

resource symbolicname 'Microsoft.ServiceBus/namespaces/queues@2024-01-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    autoDeleteOnIdle: 'string'
    deadLetteringOnMessageExpiration: bool
    defaultMessageTimeToLive: 'string'
    duplicateDetectionHistoryTimeWindow: 'string'
    enableBatchedOperations: bool
    enableExpress: bool
    enablePartitioning: bool
    forwardDeadLetteredMessagesTo: 'string'
    forwardTo: 'string'
    lockDuration: 'string'
    maxDeliveryCount: int
    maxMessageSizeInKilobytes: int
    maxSizeInMegabytes: int
    requiresDuplicateDetection: bool
    requiresSession: bool
    status: 'string'
  }
}

Wartości właściwości

Microsoft.ServiceBus/przestrzenie nazw/kolejki

Nazwa	Opis	Wartość
nazwa	Nazwa zasobu	struna Ograniczenia: Minimalna długość = 1 (wymagana)
rodzic	W Bicep można określić zasób nadrzędny dla zasobu podrzędnego. Tę właściwość należy dodać tylko wtedy, gdy zasób podrzędny jest zadeklarowany poza zasobem nadrzędnym. Aby uzyskać więcej informacji, zobacz Zasób podrzędny poza zasobem nadrzędnym.	Nazwa symboliczna zasobu typu: przestrzeni nazw
Właściwości	Właściwości kolejki	SBQueueProperties

SBQueueProperties

Nazwa	Opis	Wartość
autoDeleteOnIdle	Interwał bezczynności przedziału czasu ISO 8061, po którym kolejka zostanie automatycznie usunięta. Minimalny czas trwania wynosi 5 minut.	struna
deadLetteringOnMessageExpiration	Wartość wskazująca, czy ta kolejka ma obsługę utraconych komunikatów po wygaśnięciu komunikatu.	Bool
defaultMessageTimeToLive	Domyślny przedział czasu komunikatu ISO 8601 na wartość dynamiczną. Jest to czas trwania, po upływie którego komunikat wygaśnie, począwszy od momentu wysłania komunikatu do usługi Service Bus. Jest to wartość domyślna używana, gdy właściwość TimeToLive nie jest ustawiona dla samego komunikatu.	struna
duplicateDetectionHistoryTimeWindow	Struktura timeSpan ISO 8601, która definiuje czas trwania historii wykrywania duplikatów. Wartość domyślna to 10 minut.	struna
enableBatchedOperations	Wartość wskazująca, czy operacje wsadowe po stronie serwera są włączone.	Bool
enableExpress	Wartość wskazująca, czy jednostki express są włączone. Kolejka ekspresowa tymczasowo przechowuje komunikat w pamięci przed zapisaniem go w magazynie trwałym.	Bool
enablePartitioning	Wartość wskazująca, czy kolejka ma być partycjonowana na wielu brokerach komunikatów.	Bool
forwardDeadLetteredMessagesTo	Nazwa kolejki/tematu do przekazywania komunikatu utraconych wiadomości	struna
forwardTo	Nazwa kolejki/tematu do przekazywania komunikatów	struna
lockDuration	Czas trwania przedziału czasu ISO 8601 dla zajrzyj do blokady; oznacza to, że czas blokowania komunikatu dla innych odbiorników. Maksymalna wartość parametru LockDuration wynosi 5 minut; wartość domyślna to 1 minuta.	struna
maxDeliveryCount	Maksymalna liczba dostaw. Komunikat jest automatycznie martwy po tej liczbie dostaw. wartość domyślna to 10.	Int
maxMessageSizeInKilobytes	Maksymalny rozmiar (w KB) ładunku komunikatu, który można zaakceptować przez kolejkę. Ta właściwość jest używana tylko w warstwie Premium dzisiaj, a wartość domyślna to 1024.	Int
maxSizeInMegabytes	Maksymalny rozmiar kolejki w megabajtach, czyli rozmiar pamięci przydzielonej do kolejki. Wartość domyślna to 1024.	Int
requiresDuplicateDetection	Wartość wskazująca, czy ta kolejka wymaga wykrywania duplikatów.	Bool
wymagaSesja	Wartość wskazująca, czy kolejka obsługuje koncepcję sesji.	Bool
stan	Wylicza możliwe wartości stanu jednostki obsługi komunikatów.	"Aktywne" "Tworzenie" "Usuwanie" "Wyłączone" "ReceiveDisabled" "Zmiana nazwy" "Przywracanie" "SendDisabled" "Nieznany"

Przykłady z przewodnika Szybki start

W poniższych przykładach szybkiego startu wdrożono ten typ zasobu.

Plik Bicep	Opis
tworzenie przestrzeni nazw i kolejki usługi Service Bus	Ten szablon umożliwia wdrożenie przestrzeni nazw usługi Service Bus w warstwie Standardowa i kolejki.
tworzenie niestandardowego tematu i subskrypcji kolejki usługi Azure Event Grid	Tworzy niestandardowy temat usługi Azure Event Grid i subskrypcję kolejki usługi Service Bus. Szablon pierwotnie autorstwa Markusa Meyera.

Definicja zasobu szablonu usługi ARM

Typ zasobu przestrzeni nazw/kolejek można wdrożyć przy użyciu operacji docelowych:

• grupy zasobów — zobacz polecenia wdrażania grupy zasobów

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.ServiceBus/namespaces/queues, dodaj następujący kod JSON do szablonu.

{
  "type": "Microsoft.ServiceBus/namespaces/queues",
  "apiVersion": "2024-01-01",
  "name": "string",
  "properties": {
    "autoDeleteOnIdle": "string",
    "deadLetteringOnMessageExpiration": "bool",
    "defaultMessageTimeToLive": "string",
    "duplicateDetectionHistoryTimeWindow": "string",
    "enableBatchedOperations": "bool",
    "enableExpress": "bool",
    "enablePartitioning": "bool",
    "forwardDeadLetteredMessagesTo": "string",
    "forwardTo": "string",
    "lockDuration": "string",
    "maxDeliveryCount": "int",
    "maxMessageSizeInKilobytes": "int",
    "maxSizeInMegabytes": "int",
    "requiresDuplicateDetection": "bool",
    "requiresSession": "bool",
    "status": "string"
  }
}

Wartości właściwości

Microsoft.ServiceBus/przestrzenie nazw/kolejki

Nazwa	Opis	Wartość
apiVersion	Wersja interfejsu API	'2024-01-01'
nazwa	Nazwa zasobu	struna Ograniczenia: Minimalna długość = 1 (wymagana)
Właściwości	Właściwości kolejki	SBQueueProperties
typ	Typ zasobu	"Microsoft.ServiceBus/namespaces/queues"

SBQueueProperties

Nazwa	Opis	Wartość
autoDeleteOnIdle	Interwał bezczynności przedziału czasu ISO 8061, po którym kolejka zostanie automatycznie usunięta. Minimalny czas trwania wynosi 5 minut.	struna
deadLetteringOnMessageExpiration	Wartość wskazująca, czy ta kolejka ma obsługę utraconych komunikatów po wygaśnięciu komunikatu.	Bool
defaultMessageTimeToLive	Domyślny przedział czasu komunikatu ISO 8601 na wartość dynamiczną. Jest to czas trwania, po upływie którego komunikat wygaśnie, począwszy od momentu wysłania komunikatu do usługi Service Bus. Jest to wartość domyślna używana, gdy właściwość TimeToLive nie jest ustawiona dla samego komunikatu.	struna
duplicateDetectionHistoryTimeWindow	Struktura timeSpan ISO 8601, która definiuje czas trwania historii wykrywania duplikatów. Wartość domyślna to 10 minut.	struna
enableBatchedOperations	Wartość wskazująca, czy operacje wsadowe po stronie serwera są włączone.	Bool
enableExpress	Wartość wskazująca, czy jednostki express są włączone. Kolejka ekspresowa tymczasowo przechowuje komunikat w pamięci przed zapisaniem go w magazynie trwałym.	Bool
enablePartitioning	Wartość wskazująca, czy kolejka ma być partycjonowana na wielu brokerach komunikatów.	Bool
forwardDeadLetteredMessagesTo	Nazwa kolejki/tematu do przekazywania komunikatu utraconych wiadomości	struna
forwardTo	Nazwa kolejki/tematu do przekazywania komunikatów	struna
lockDuration	Czas trwania przedziału czasu ISO 8601 dla zajrzyj do blokady; oznacza to, że czas blokowania komunikatu dla innych odbiorników. Maksymalna wartość parametru LockDuration wynosi 5 minut; wartość domyślna to 1 minuta.	struna
maxDeliveryCount	Maksymalna liczba dostaw. Komunikat jest automatycznie martwy po tej liczbie dostaw. wartość domyślna to 10.	Int
maxMessageSizeInKilobytes	Maksymalny rozmiar (w KB) ładunku komunikatu, który można zaakceptować przez kolejkę. Ta właściwość jest używana tylko w warstwie Premium dzisiaj, a wartość domyślna to 1024.	Int
maxSizeInMegabytes	Maksymalny rozmiar kolejki w megabajtach, czyli rozmiar pamięci przydzielonej do kolejki. Wartość domyślna to 1024.	Int
requiresDuplicateDetection	Wartość wskazująca, czy ta kolejka wymaga wykrywania duplikatów.	Bool
wymagaSesja	Wartość wskazująca, czy kolejka obsługuje koncepcję sesji.	Bool
stan	Wylicza możliwe wartości stanu jednostki obsługi komunikatów.	"Aktywne" "Tworzenie" "Usuwanie" "Wyłączone" "ReceiveDisabled" "Zmiana nazwy" "Przywracanie" "SendDisabled" "Nieznany"

Szablony szybkiego startu

Następujące szablony szybkiego startu wdrażają ten typ zasobu.

Szablon	Opis
tworzenie przestrzeni nazw i kolejki usługi Service Bus wdrażanie	Ten szablon umożliwia wdrożenie przestrzeni nazw usługi Service Bus w warstwie Standardowa i kolejki.
tworzenie niestandardowego tematu i subskrypcji kolejki usługi Azure Event Grid wdrażanie	Tworzy niestandardowy temat usługi Azure Event Grid i subskrypcję kolejki usługi Service Bus. Szablon pierwotnie autorstwa Markusa Meyera.

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu przestrzeni nazw/kolejek można wdrożyć przy użyciu operacji docelowych:

• grupy zasobów

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.ServiceBus/namespaces/queues, dodaj następujący program Terraform do szablonu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ServiceBus/namespaces/queues@2024-01-01"
  name = "string"
  body = jsonencode({
    properties = {
      autoDeleteOnIdle = "string"
      deadLetteringOnMessageExpiration = bool
      defaultMessageTimeToLive = "string"
      duplicateDetectionHistoryTimeWindow = "string"
      enableBatchedOperations = bool
      enableExpress = bool
      enablePartitioning = bool
      forwardDeadLetteredMessagesTo = "string"
      forwardTo = "string"
      lockDuration = "string"
      maxDeliveryCount = int
      maxMessageSizeInKilobytes = int
      maxSizeInMegabytes = int
      requiresDuplicateDetection = bool
      requiresSession = bool
      status = "string"
    }
  })
}

Wartości właściwości

Microsoft.ServiceBus/przestrzenie nazw/kolejki

Nazwa	Opis	Wartość
nazwa	Nazwa zasobu	struna Ograniczenia: Minimalna długość = 1 (wymagana)
parent_id	Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu.	Identyfikator zasobu typu: przestrzeni nazw
Właściwości	Właściwości kolejki	SBQueueProperties
typ	Typ zasobu	"Microsoft.ServiceBus/namespaces/queues@2024-01-01"

SBQueueProperties

Nazwa	Opis	Wartość
autoDeleteOnIdle	Interwał bezczynności przedziału czasu ISO 8061, po którym kolejka zostanie automatycznie usunięta. Minimalny czas trwania wynosi 5 minut.	struna
deadLetteringOnMessageExpiration	Wartość wskazująca, czy ta kolejka ma obsługę utraconych komunikatów po wygaśnięciu komunikatu.	Bool
defaultMessageTimeToLive	Domyślny przedział czasu komunikatu ISO 8601 na wartość dynamiczną. Jest to czas trwania, po upływie którego komunikat wygaśnie, począwszy od momentu wysłania komunikatu do usługi Service Bus. Jest to wartość domyślna używana, gdy właściwość TimeToLive nie jest ustawiona dla samego komunikatu.	struna
duplicateDetectionHistoryTimeWindow	Struktura timeSpan ISO 8601, która definiuje czas trwania historii wykrywania duplikatów. Wartość domyślna to 10 minut.	struna
enableBatchedOperations	Wartość wskazująca, czy operacje wsadowe po stronie serwera są włączone.	Bool
enableExpress	Wartość wskazująca, czy jednostki express są włączone. Kolejka ekspresowa tymczasowo przechowuje komunikat w pamięci przed zapisaniem go w magazynie trwałym.	Bool
enablePartitioning	Wartość wskazująca, czy kolejka ma być partycjonowana na wielu brokerach komunikatów.	Bool
forwardDeadLetteredMessagesTo	Nazwa kolejki/tematu do przekazywania komunikatu utraconych wiadomości	struna
forwardTo	Nazwa kolejki/tematu do przekazywania komunikatów	struna
lockDuration	Czas trwania przedziału czasu ISO 8601 dla zajrzyj do blokady; oznacza to, że czas blokowania komunikatu dla innych odbiorników. Maksymalna wartość parametru LockDuration wynosi 5 minut; wartość domyślna to 1 minuta.	struna
maxDeliveryCount	Maksymalna liczba dostaw. Komunikat jest automatycznie martwy po tej liczbie dostaw. wartość domyślna to 10.	Int
maxMessageSizeInKilobytes	Maksymalny rozmiar (w KB) ładunku komunikatu, który można zaakceptować przez kolejkę. Ta właściwość jest używana tylko w warstwie Premium dzisiaj, a wartość domyślna to 1024.	Int
maxSizeInMegabytes	Maksymalny rozmiar kolejki w megabajtach, czyli rozmiar pamięci przydzielonej do kolejki. Wartość domyślna to 1024.	Int
requiresDuplicateDetection	Wartość wskazująca, czy ta kolejka wymaga wykrywania duplikatów.	Bool
wymagaSesja	Wartość wskazująca, czy kolejka obsługuje koncepcję sesji.	Bool
stan	Wylicza możliwe wartości stanu jednostki obsługi komunikatów.	"Aktywne" "Tworzenie" "Usuwanie" "Wyłączone" "ReceiveDisabled" "Zmiana nazwy" "Przywracanie" "SendDisabled" "Nieznany"