servicebus.azure.com/v1beta20210101preview
servicebus.azure.com/v1beta20210101preview
Package v1beta20210101preview contains API Schema definitions for the servicebus v1beta20210101preview API group
APIVersion
(string
alias)
Value | Description |
---|---|
"2021-01-01-preview" |
DictionaryValue_Status
(Appears on:Identity_Status)
Field | Description |
---|---|
clientId string |
ClientId: Client Id of user assigned identity |
principalId string |
PrincipalId: Principal Id of user assigned identity |
DictionaryValue_StatusARM
(Appears on:Identity_StatusARM)
Field | Description |
---|---|
clientId string |
ClientId: Client Id of user assigned identity |
principalId string |
PrincipalId: Principal Id of user assigned identity |
Encryption
(Appears on:Namespaces_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-01-01-preview/Microsoft.ServiceBus.json#/definitions/Encryption
Field | Description |
---|---|
keySource EncryptionKeySource |
KeySource: Enumerates the possible value of keySource for Encryption. |
keyVaultProperties []KeyVaultProperties |
KeyVaultProperties: Properties of KeyVault |
requireInfrastructureEncryption bool |
RequireInfrastructureEncryption: Enable Infrastructure Encryption (Double Encryption) |
EncryptionARM
(Appears on:Namespaces_Spec_PropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-01-01-preview/Microsoft.ServiceBus.json#/definitions/Encryption
Field | Description |
---|---|
keySource EncryptionKeySource |
KeySource: Enumerates the possible value of keySource for Encryption. |
keyVaultProperties []KeyVaultPropertiesARM |
KeyVaultProperties: Properties of KeyVault |
requireInfrastructureEncryption bool |
RequireInfrastructureEncryption: Enable Infrastructure Encryption (Double Encryption) |
EncryptionKeySource
(string
alias)
(Appears on:Encryption, EncryptionARM)
Value | Description |
---|---|
"Microsoft.KeyVault" |
EncryptionStatusKeySource
(string
alias)
(Appears on:Encryption_Status, Encryption_StatusARM)
Value | Description |
---|---|
"Microsoft.KeyVault" |
Encryption_Status
(Appears on:SBNamespace_Status)
Field | Description |
---|---|
keySource EncryptionStatusKeySource |
KeySource: Enumerates the possible value of keySource for Encryption |
keyVaultProperties []KeyVaultProperties_Status |
KeyVaultProperties: Properties of KeyVault |
requireInfrastructureEncryption bool |
RequireInfrastructureEncryption: Enable Infrastructure Encryption (Double Encryption) |
Encryption_StatusARM
(Appears on:SBNamespaceProperties_StatusARM)
Field | Description |
---|---|
keySource EncryptionStatusKeySource |
KeySource: Enumerates the possible value of keySource for Encryption |
keyVaultProperties []KeyVaultProperties_StatusARM |
KeyVaultProperties: Properties of KeyVault |
requireInfrastructureEncryption bool |
RequireInfrastructureEncryption: Enable Infrastructure Encryption (Double Encryption) |
EntityStatus_Status
(string
alias)
(Appears on:SBQueueProperties_StatusARM, SBQueue_Status, SBTopicProperties_StatusARM, SBTopic_Status)
Value | Description |
---|---|
"Active" |
|
"Creating" |
|
"Deleting" |
|
"Disabled" |
|
"ReceiveDisabled" |
|
"Renaming" |
|
"Restoring" |
|
"SendDisabled" |
|
"Unknown" |
Identity
(Appears on:Namespaces_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-01-01-preview/Microsoft.ServiceBus.json#/definitions/Identity
Field | Description |
---|---|
type IdentityType |
Type: Type of managed service identity. |
IdentityARM
(Appears on:Namespaces_SpecARM)
Generated from: https://schema.management.azure.com/schemas/2021-01-01-preview/Microsoft.ServiceBus.json#/definitions/Identity
Field | Description |
---|---|
type IdentityType |
Type: Type of managed service identity. |
IdentityStatusType
(string
alias)
(Appears on:Identity_Status, Identity_StatusARM)
Value | Description |
---|---|
"None" |
|
"SystemAssigned" |
|
"SystemAssigned, UserAssigned" |
|
"UserAssigned" |
IdentityType
(string
alias)
(Appears on:Identity, IdentityARM)
Value | Description |
---|---|
"None" |
|
"SystemAssigned" |
|
"SystemAssigned, UserAssigned" |
|
"UserAssigned" |
Identity_Status
(Appears on:SBNamespace_Status)
Field | Description |
---|---|
principalId string |
PrincipalId: ObjectId from the KeyVault |
tenantId string |
TenantId: TenantId from the KeyVault |
type IdentityStatusType |
Type: Type of managed service identity. |
userAssignedIdentities map[string]./api/servicebus/v1beta20210101preview.DictionaryValue_Status |
UserAssignedIdentities: Properties for User Assigned Identities |
Identity_StatusARM
(Appears on:SBNamespace_StatusARM)
Field | Description |
---|---|
principalId string |
PrincipalId: ObjectId from the KeyVault |
tenantId string |
TenantId: TenantId from the KeyVault |
type IdentityStatusType |
Type: Type of managed service identity. |
userAssignedIdentities map[string]./api/servicebus/v1beta20210101preview.DictionaryValue_StatusARM |
UserAssignedIdentities: Properties for User Assigned Identities |
KeyVaultProperties
(Appears on:Encryption)
Generated from: https://schema.management.azure.com/schemas/2021-01-01-preview/Microsoft.ServiceBus.json#/definitions/KeyVaultProperties
Field | Description |
---|---|
identity UserAssignedIdentityProperties |
|
keyName string |
KeyName: Name of the Key from KeyVault |
keyVaultUri string |
KeyVaultUri: Uri of KeyVault |
keyVersion string |
KeyVersion: Version of KeyVault |
KeyVaultPropertiesARM
(Appears on:EncryptionARM)
Generated from: https://schema.management.azure.com/schemas/2021-01-01-preview/Microsoft.ServiceBus.json#/definitions/KeyVaultProperties
Field | Description |
---|---|
identity UserAssignedIdentityPropertiesARM |
|
keyName string |
KeyName: Name of the Key from KeyVault |
keyVaultUri string |
KeyVaultUri: Uri of KeyVault |
keyVersion string |
KeyVersion: Version of KeyVault |
KeyVaultProperties_Status
(Appears on:Encryption_Status)
Field | Description |
---|---|
identity UserAssignedIdentityProperties_Status |
|
keyName string |
KeyName: Name of the Key from KeyVault |
keyVaultUri string |
KeyVaultUri: Uri of KeyVault |
keyVersion string |
KeyVersion: Version of KeyVault |
KeyVaultProperties_StatusARM
(Appears on:Encryption_StatusARM)
Field | Description |
---|---|
identity UserAssignedIdentityProperties_StatusARM |
|
keyName string |
KeyName: Name of the Key from KeyVault |
keyVaultUri string |
KeyVaultUri: Uri of KeyVault |
keyVersion string |
KeyVersion: Version of KeyVault |
MessageCountDetails_Status
(Appears on:SBQueue_Status, SBTopic_Status)
Field | Description |
---|---|
activeMessageCount int |
ActiveMessageCount: Number of active messages in the queue, topic, or subscription. |
deadLetterMessageCount int |
DeadLetterMessageCount: Number of messages that are dead lettered. |
scheduledMessageCount int |
ScheduledMessageCount: Number of scheduled messages. |
transferDeadLetterMessageCount int |
TransferDeadLetterMessageCount: Number of messages transferred into dead letters. |
transferMessageCount int |
TransferMessageCount: Number of messages transferred to another queue, topic, or subscription. |
MessageCountDetails_StatusARM
(Appears on:SBQueueProperties_StatusARM, SBTopicProperties_StatusARM)
Field | Description |
---|---|
activeMessageCount int |
ActiveMessageCount: Number of active messages in the queue, topic, or subscription. |
deadLetterMessageCount int |
DeadLetterMessageCount: Number of messages that are dead lettered. |
scheduledMessageCount int |
ScheduledMessageCount: Number of scheduled messages. |
transferDeadLetterMessageCount int |
TransferDeadLetterMessageCount: Number of messages transferred into dead letters. |
transferMessageCount int |
TransferMessageCount: Number of messages transferred to another queue, topic, or subscription. |
Namespace
Generated from: https://schema.management.azure.com/schemas/2021-01-01-preview/Microsoft.ServiceBus.json#/resourceDefinitions/namespaces
Field | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||
spec Namespaces_Spec |
|
||||||||||||||||
status SBNamespace_Status |
NamespacesQueue
Generated from: https://schema.management.azure.com/schemas/2021-01-01-preview/Microsoft.ServiceBus.json#/resourceDefinitions/namespaces_queues
Field | Description | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||||||||||||||||
spec NamespacesQueues_Spec |
|
||||||||||||||||||||||||||||||||||||
status SBQueue_Status |
NamespacesQueues_Spec
(Appears on:NamespacesQueue)
Field | Description |
---|---|
autoDeleteOnIdle string |
AutoDeleteOnIdle: ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes. |
azureName string |
AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. |
deadLetteringOnMessageExpiration bool |
DeadLetteringOnMessageExpiration: A value that indicates whether this queue has dead letter support when a message expires. |
defaultMessageTimeToLive string |
DefaultMessageTimeToLive: ISO 8601 default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself. |
duplicateDetectionHistoryTimeWindow string |
DuplicateDetectionHistoryTimeWindow: ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. |
enableBatchedOperations bool |
EnableBatchedOperations: Value that indicates whether server-side batched operations are enabled. |
enableExpress bool |
EnableExpress: A value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage. |
enablePartitioning bool |
EnablePartitioning: A value that indicates whether the queue is to be partitioned across multiple message brokers. |
forwardDeadLetteredMessagesTo string |
ForwardDeadLetteredMessagesTo: Queue/Topic name to forward the Dead Letter message |
forwardTo string |
ForwardTo: Queue/Topic name to forward the messages |
location string |
Location: Location to deploy resource to |
lockDuration string |
LockDuration: ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute. |
maxDeliveryCount int |
MaxDeliveryCount: The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10. |
maxSizeInMegabytes int |
MaxSizeInMegabytes: The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024. |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a servicebus.azure.com/Namespace resource |
requiresDuplicateDetection bool |
RequiresDuplicateDetection: A value indicating if this queue requires duplicate detection. |
requiresSession bool |
RequiresSession: A value that indicates whether the queue supports the concept of sessions. |
tags map[string]string |
Tags: Name-value pairs to add to the resource |
NamespacesQueues_SpecARM
Field | Description |
---|---|
location string |
Location: Location to deploy resource to |
name string |
Name: Name of the resource |
properties SBQueuePropertiesARM |
Properties: The Queue Properties definition. |
tags map[string]string |
Tags: Name-value pairs to add to the resource |
NamespacesTopic
Generated from: https://schema.management.azure.com/schemas/2021-01-01-preview/Microsoft.ServiceBus.json#/resourceDefinitions/namespaces_topics
Field | Description | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||||||
spec NamespacesTopics_Spec |
|
||||||||||||||||||||||||||
status SBTopic_Status |
NamespacesTopics_Spec
(Appears on:NamespacesTopic)
Field | Description |
---|---|
autoDeleteOnIdle string |
AutoDeleteOnIdle: ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. |
azureName string |
AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. |
defaultMessageTimeToLive string |
DefaultMessageTimeToLive: ISO 8601 Default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself. |
duplicateDetectionHistoryTimeWindow string |
DuplicateDetectionHistoryTimeWindow: ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. |
enableBatchedOperations bool |
EnableBatchedOperations: Value that indicates whether server-side batched operations are enabled. |
enableExpress bool |
EnableExpress: Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage. |
enablePartitioning bool |
EnablePartitioning: Value that indicates whether the topic to be partitioned across multiple message brokers is enabled. |
location string |
Location: Location to deploy resource to |
maxSizeInMegabytes int |
MaxSizeInMegabytes: Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024. |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a servicebus.azure.com/Namespace resource |
requiresDuplicateDetection bool |
RequiresDuplicateDetection: Value indicating if this topic requires duplicate detection. |
supportOrdering bool |
SupportOrdering: Value that indicates whether the topic supports ordering. |
tags map[string]string |
Tags: Name-value pairs to add to the resource |
NamespacesTopics_SpecARM
Field | Description |
---|---|
location string |
Location: Location to deploy resource to |
name string |
Name: Name of the resource |
properties SBTopicPropertiesARM |
Properties: The Topic Properties definition. |
tags map[string]string |
Tags: Name-value pairs to add to the resource |
Namespaces_Spec
(Appears on:Namespace)
Field | Description |
---|---|
azureName string |
AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. |
encryption Encryption |
Encryption: Properties to configure Encryption |
identity Identity |
Identity: Properties to configure User Assigned Identities for Bring your Own Keys |
location string |
Location: The Geo-location where the resource lives |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource |
sku SBSku |
Sku: SKU of the namespace. |
tags map[string]string |
Tags: Name-value pairs to add to the resource |
zoneRedundant bool |
ZoneRedundant: Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones. |
Namespaces_SpecARM
Field | Description |
---|---|
identity IdentityARM |
Identity: Properties to configure User Assigned Identities for Bring your Own Keys |
location string |
Location: The Geo-location where the resource lives |
name string |
Name: Name of the resource |
properties Namespaces_Spec_PropertiesARM |
Properties: Properties of the namespace. |
sku SBSkuARM |
Sku: SKU of the namespace. |
tags map[string]string |
Tags: Name-value pairs to add to the resource |
Namespaces_Spec_PropertiesARM
(Appears on:Namespaces_SpecARM)
Field | Description |
---|---|
encryption EncryptionARM |
Encryption: Properties to configure Encryption |
zoneRedundant bool |
ZoneRedundant: Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones. |
PrivateEndpointConnection_Status_SubResourceEmbedded
(Appears on:SBNamespace_Status)
Field | Description |
---|---|
id string |
Id: Resource Id |
systemData SystemData_Status |
SystemData: The system meta data relating to this resource. |
PrivateEndpointConnection_Status_SubResourceEmbeddedARM
(Appears on:SBNamespaceProperties_StatusARM)
Field | Description |
---|---|
id string |
Id: Resource Id |
systemData SystemData_StatusARM |
SystemData: The system meta data relating to this resource. |
SBNamespaceProperties_StatusARM
(Appears on:SBNamespace_StatusARM)
Field | Description |
---|---|
createdAt string |
CreatedAt: The time the namespace was created |
encryption Encryption_StatusARM |
Encryption: Properties of BYOK Encryption description |
metricId string |
MetricId: Identifier for Azure Insights metrics |
privateEndpointConnections []PrivateEndpointConnection_Status_SubResourceEmbeddedARM |
PrivateEndpointConnections: List of private endpoint connections. |
provisioningState string |
ProvisioningState: Provisioning state of the namespace. |
serviceBusEndpoint string |
ServiceBusEndpoint: Endpoint you can use to perform Service Bus operations. |
status string |
Status: Status of the namespace. |
updatedAt string |
UpdatedAt: The time the namespace was updated. |
zoneRedundant bool |
ZoneRedundant: Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones. |
SBNamespace_Status
(Appears on:Namespace)
Field | Description |
---|---|
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
createdAt string |
CreatedAt: The time the namespace was created |
encryption Encryption_Status |
Encryption: Properties of BYOK Encryption description |
id string |
Id: Resource Id |
identity Identity_Status |
Identity: Properties of BYOK Identity description |
location string |
Location: The Geo-location where the resource lives |
metricId string |
MetricId: Identifier for Azure Insights metrics |
name string |
Name: Resource name |
privateEndpointConnections []PrivateEndpointConnection_Status_SubResourceEmbedded |
PrivateEndpointConnections: List of private endpoint connections. |
provisioningState string |
ProvisioningState: Provisioning state of the namespace. |
serviceBusEndpoint string |
ServiceBusEndpoint: Endpoint you can use to perform Service Bus operations. |
sku SBSku_Status |
Sku: Properties of SKU |
status string |
Status: Status of the namespace. |
systemData SystemData_Status |
SystemData: The system meta data relating to this resource. |
tags map[string]string |
Tags: Resource tags |
type string |
Type: Resource type |
updatedAt string |
UpdatedAt: The time the namespace was updated. |
zoneRedundant bool |
ZoneRedundant: Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones. |
SBNamespace_StatusARM
Field | Description |
---|---|
id string |
Id: Resource Id |
identity Identity_StatusARM |
Identity: Properties of BYOK Identity description |
location string |
Location: The Geo-location where the resource lives |
name string |
Name: Resource name |
properties SBNamespaceProperties_StatusARM |
Properties: Properties of the namespace. |
sku SBSku_StatusARM |
Sku: Properties of SKU |
systemData SystemData_StatusARM |
SystemData: The system meta data relating to this resource. |
tags map[string]string |
Tags: Resource tags |
type string |
Type: Resource type |
SBQueuePropertiesARM
(Appears on:NamespacesQueues_SpecARM)
Generated from: https://schema.management.azure.com/schemas/2021-01-01-preview/Microsoft.ServiceBus.json#/definitions/SBQueueProperties
Field | Description |
---|---|
autoDeleteOnIdle string |
AutoDeleteOnIdle: ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes. |
deadLetteringOnMessageExpiration bool |
DeadLetteringOnMessageExpiration: A value that indicates whether this queue has dead letter support when a message expires. |
defaultMessageTimeToLive string |
DefaultMessageTimeToLive: ISO 8601 default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself. |
duplicateDetectionHistoryTimeWindow string |
DuplicateDetectionHistoryTimeWindow: ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. |
enableBatchedOperations bool |
EnableBatchedOperations: Value that indicates whether server-side batched operations are enabled. |
enableExpress bool |
EnableExpress: A value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage. |
enablePartitioning bool |
EnablePartitioning: A value that indicates whether the queue is to be partitioned across multiple message brokers. |
forwardDeadLetteredMessagesTo string |
ForwardDeadLetteredMessagesTo: Queue/Topic name to forward the Dead Letter message |
forwardTo string |
ForwardTo: Queue/Topic name to forward the messages |
lockDuration string |
LockDuration: ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute. |
maxDeliveryCount int |
MaxDeliveryCount: The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10. |
maxSizeInMegabytes int |
MaxSizeInMegabytes: The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024. |
requiresDuplicateDetection bool |
RequiresDuplicateDetection: A value indicating if this queue requires duplicate detection. |
requiresSession bool |
RequiresSession: A value that indicates whether the queue supports the concept of sessions. |
SBQueueProperties_StatusARM
(Appears on:SBQueue_StatusARM)
Field | Description |
---|---|
accessedAt string |
AccessedAt: Last time a message was sent, or the last time there was a receive request to this queue. |
autoDeleteOnIdle string |
AutoDeleteOnIdle: ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes. |
countDetails MessageCountDetails_StatusARM |
CountDetails: Message Count Details. |
createdAt string |
CreatedAt: The exact time the message was created. |
deadLetteringOnMessageExpiration bool |
DeadLetteringOnMessageExpiration: A value that indicates whether this queue has dead letter support when a message expires. |
defaultMessageTimeToLive string |
DefaultMessageTimeToLive: ISO 8601 default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself. |
duplicateDetectionHistoryTimeWindow string |
DuplicateDetectionHistoryTimeWindow: ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. |
enableBatchedOperations bool |
EnableBatchedOperations: Value that indicates whether server-side batched operations are enabled. |
enableExpress bool |
EnableExpress: A value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage. |
enablePartitioning bool |
EnablePartitioning: A value that indicates whether the queue is to be partitioned across multiple message brokers. |
forwardDeadLetteredMessagesTo string |
ForwardDeadLetteredMessagesTo: Queue/Topic name to forward the Dead Letter message |
forwardTo string |
ForwardTo: Queue/Topic name to forward the messages |
lockDuration string |
LockDuration: ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute. |
maxDeliveryCount int |
MaxDeliveryCount: The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10. |
maxSizeInMegabytes int |
MaxSizeInMegabytes: The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024. |
messageCount int |
MessageCount: The number of messages in the queue. |
requiresDuplicateDetection bool |
RequiresDuplicateDetection: A value indicating if this queue requires duplicate detection. |
requiresSession bool |
RequiresSession: A value that indicates whether the queue supports the concept of sessions. |
sizeInBytes int |
SizeInBytes: The size of the queue, in bytes. |
status EntityStatus_Status |
Status: Enumerates the possible values for the status of a messaging entity. |
updatedAt string |
UpdatedAt: The exact time the message was updated. |
SBQueue_Status
(Appears on:NamespacesQueue)
Field | Description |
---|---|
accessedAt string |
AccessedAt: Last time a message was sent, or the last time there was a receive request to this queue. |
autoDeleteOnIdle string |
AutoDeleteOnIdle: ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes. |
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
countDetails MessageCountDetails_Status |
CountDetails: Message Count Details. |
createdAt string |
CreatedAt: The exact time the message was created. |
deadLetteringOnMessageExpiration bool |
DeadLetteringOnMessageExpiration: A value that indicates whether this queue has dead letter support when a message expires. |
defaultMessageTimeToLive string |
DefaultMessageTimeToLive: ISO 8601 default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself. |
duplicateDetectionHistoryTimeWindow string |
DuplicateDetectionHistoryTimeWindow: ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. |
enableBatchedOperations bool |
EnableBatchedOperations: Value that indicates whether server-side batched operations are enabled. |
enableExpress bool |
EnableExpress: A value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage. |
enablePartitioning bool |
EnablePartitioning: A value that indicates whether the queue is to be partitioned across multiple message brokers. |
forwardDeadLetteredMessagesTo string |
ForwardDeadLetteredMessagesTo: Queue/Topic name to forward the Dead Letter message |
forwardTo string |
ForwardTo: Queue/Topic name to forward the messages |
id string |
Id: Resource Id |
lockDuration string |
LockDuration: ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute. |
maxDeliveryCount int |
MaxDeliveryCount: The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10. |
maxSizeInMegabytes int |
MaxSizeInMegabytes: The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024. |
messageCount int |
MessageCount: The number of messages in the queue. |
name string |
Name: Resource name |
requiresDuplicateDetection bool |
RequiresDuplicateDetection: A value indicating if this queue requires duplicate detection. |
requiresSession bool |
RequiresSession: A value that indicates whether the queue supports the concept of sessions. |
sizeInBytes int |
SizeInBytes: The size of the queue, in bytes. |
status EntityStatus_Status |
Status: Enumerates the possible values for the status of a messaging entity. |
systemData SystemData_Status |
SystemData: The system meta data relating to this resource. |
type string |
Type: Resource type |
updatedAt string |
UpdatedAt: The exact time the message was updated. |
SBQueue_StatusARM
Field | Description |
---|---|
id string |
Id: Resource Id |
name string |
Name: Resource name |
properties SBQueueProperties_StatusARM |
Properties: Queue Properties |
systemData SystemData_StatusARM |
SystemData: The system meta data relating to this resource. |
type string |
Type: Resource type |
SBSku
(Appears on:Namespaces_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-01-01-preview/Microsoft.ServiceBus.json#/definitions/SBSku
Field | Description |
---|---|
capacity int |
Capacity: The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4. |
name SBSkuName |
Name: Name of this SKU. |
tier SBSkuTier |
Tier: The billing tier of this particular SKU. |
SBSkuARM
(Appears on:Namespaces_SpecARM)
Generated from: https://schema.management.azure.com/schemas/2021-01-01-preview/Microsoft.ServiceBus.json#/definitions/SBSku
Field | Description |
---|---|
capacity int |
Capacity: The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4. |
name SBSkuName |
Name: Name of this SKU. |
tier SBSkuTier |
Tier: The billing tier of this particular SKU. |
SBSkuName
(string
alias)
Value | Description |
---|---|
"Basic" |
|
"Premium" |
|
"Standard" |
SBSkuStatusName
(string
alias)
(Appears on:SBSku_Status, SBSku_StatusARM)
Value | Description |
---|---|
"Basic" |
|
"Premium" |
|
"Standard" |
SBSkuStatusTier
(string
alias)
(Appears on:SBSku_Status, SBSku_StatusARM)
Value | Description |
---|---|
"Basic" |
|
"Premium" |
|
"Standard" |
SBSkuTier
(string
alias)
Value | Description |
---|---|
"Basic" |
|
"Premium" |
|
"Standard" |
SBSku_Status
(Appears on:SBNamespace_Status)
Field | Description |
---|---|
capacity int |
Capacity: The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4. |
name SBSkuStatusName |
Name: Name of this SKU. |
tier SBSkuStatusTier |
Tier: The billing tier of this particular SKU. |
SBSku_StatusARM
(Appears on:SBNamespace_StatusARM)
Field | Description |
---|---|
capacity int |
Capacity: The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4. |
name SBSkuStatusName |
Name: Name of this SKU. |
tier SBSkuStatusTier |
Tier: The billing tier of this particular SKU. |
SBTopicPropertiesARM
(Appears on:NamespacesTopics_SpecARM)
Generated from: https://schema.management.azure.com/schemas/2021-01-01-preview/Microsoft.ServiceBus.json#/definitions/SBTopicProperties
Field | Description |
---|---|
autoDeleteOnIdle string |
AutoDeleteOnIdle: ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. |
defaultMessageTimeToLive string |
DefaultMessageTimeToLive: ISO 8601 Default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself. |
duplicateDetectionHistoryTimeWindow string |
DuplicateDetectionHistoryTimeWindow: ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. |
enableBatchedOperations bool |
EnableBatchedOperations: Value that indicates whether server-side batched operations are enabled. |
enableExpress bool |
EnableExpress: Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage. |
enablePartitioning bool |
EnablePartitioning: Value that indicates whether the topic to be partitioned across multiple message brokers is enabled. |
maxSizeInMegabytes int |
MaxSizeInMegabytes: Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024. |
requiresDuplicateDetection bool |
RequiresDuplicateDetection: Value indicating if this topic requires duplicate detection. |
supportOrdering bool |
SupportOrdering: Value that indicates whether the topic supports ordering. |
SBTopicProperties_StatusARM
(Appears on:SBTopic_StatusARM)
Field | Description |
---|---|
accessedAt string |
AccessedAt: Last time the message was sent, or a request was received, for this topic. |
autoDeleteOnIdle string |
AutoDeleteOnIdle: ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. |
countDetails MessageCountDetails_StatusARM |
CountDetails: Message count details |
createdAt string |
CreatedAt: Exact time the message was created. |
defaultMessageTimeToLive string |
DefaultMessageTimeToLive: ISO 8601 Default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself. |
duplicateDetectionHistoryTimeWindow string |
DuplicateDetectionHistoryTimeWindow: ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. |
enableBatchedOperations bool |
EnableBatchedOperations: Value that indicates whether server-side batched operations are enabled. |
enableExpress bool |
EnableExpress: Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage. |
enablePartitioning bool |
EnablePartitioning: Value that indicates whether the topic to be partitioned across multiple message brokers is enabled. |
maxSizeInMegabytes int |
MaxSizeInMegabytes: Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024. |
requiresDuplicateDetection bool |
RequiresDuplicateDetection: Value indicating if this topic requires duplicate detection. |
sizeInBytes int |
SizeInBytes: Size of the topic, in bytes. |
status EntityStatus_Status |
Status: Enumerates the possible values for the status of a messaging entity. |
subscriptionCount int |
SubscriptionCount: Number of subscriptions. |
supportOrdering bool |
SupportOrdering: Value that indicates whether the topic supports ordering. |
updatedAt string |
UpdatedAt: The exact time the message was updated. |
SBTopic_Status
(Appears on:NamespacesTopic)
Field | Description |
---|---|
accessedAt string |
AccessedAt: Last time the message was sent, or a request was received, for this topic. |
autoDeleteOnIdle string |
AutoDeleteOnIdle: ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. |
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
countDetails MessageCountDetails_Status |
CountDetails: Message count details |
createdAt string |
CreatedAt: Exact time the message was created. |
defaultMessageTimeToLive string |
DefaultMessageTimeToLive: ISO 8601 Default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself. |
duplicateDetectionHistoryTimeWindow string |
DuplicateDetectionHistoryTimeWindow: ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. |
enableBatchedOperations bool |
EnableBatchedOperations: Value that indicates whether server-side batched operations are enabled. |
enableExpress bool |
EnableExpress: Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage. |
enablePartitioning bool |
EnablePartitioning: Value that indicates whether the topic to be partitioned across multiple message brokers is enabled. |
id string |
Id: Resource Id |
maxSizeInMegabytes int |
MaxSizeInMegabytes: Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024. |
name string |
Name: Resource name |
requiresDuplicateDetection bool |
RequiresDuplicateDetection: Value indicating if this topic requires duplicate detection. |
sizeInBytes int |
SizeInBytes: Size of the topic, in bytes. |
status EntityStatus_Status |
Status: Enumerates the possible values for the status of a messaging entity. |
subscriptionCount int |
SubscriptionCount: Number of subscriptions. |
supportOrdering bool |
SupportOrdering: Value that indicates whether the topic supports ordering. |
systemData SystemData_Status |
SystemData: The system meta data relating to this resource. |
type string |
Type: Resource type |
updatedAt string |
UpdatedAt: The exact time the message was updated. |
SBTopic_StatusARM
Field | Description |
---|---|
id string |
Id: Resource Id |
name string |
Name: Resource name |
properties SBTopicProperties_StatusARM |
Properties: Properties of topic resource. |
systemData SystemData_StatusARM |
SystemData: The system meta data relating to this resource. |
type string |
Type: Resource type |
SystemDataStatusCreatedByType
(string
alias)
(Appears on:SystemData_Status, SystemData_StatusARM)
Value | Description |
---|---|
"Application" |
|
"Key" |
|
"ManagedIdentity" |
|
"User" |
SystemDataStatusLastModifiedByType
(string
alias)
(Appears on:SystemData_Status, SystemData_StatusARM)
Value | Description |
---|---|
"Application" |
|
"Key" |
|
"ManagedIdentity" |
|
"User" |
SystemData_Status
(Appears on:PrivateEndpointConnection_Status_SubResourceEmbedded, SBNamespace_Status, SBQueue_Status, SBTopic_Status)
Field | Description |
---|---|
createdAt string |
CreatedAt: The timestamp of resource creation (UTC). |
createdBy string |
CreatedBy: The identity that created the resource. |
createdByType SystemDataStatusCreatedByType |
CreatedByType: The type of identity that created the resource. |
lastModifiedAt string |
LastModifiedAt: The type of identity that last modified the resource. |
lastModifiedBy string |
LastModifiedBy: The identity that last modified the resource. |
lastModifiedByType SystemDataStatusLastModifiedByType |
LastModifiedByType: The type of identity that last modified the resource. |
SystemData_StatusARM
(Appears on:PrivateEndpointConnection_Status_SubResourceEmbeddedARM, SBNamespace_StatusARM, SBQueue_StatusARM, SBTopic_StatusARM)
Field | Description |
---|---|
createdAt string |
CreatedAt: The timestamp of resource creation (UTC). |
createdBy string |
CreatedBy: The identity that created the resource. |
createdByType SystemDataStatusCreatedByType |
CreatedByType: The type of identity that created the resource. |
lastModifiedAt string |
LastModifiedAt: The type of identity that last modified the resource. |
lastModifiedBy string |
LastModifiedBy: The identity that last modified the resource. |
lastModifiedByType SystemDataStatusLastModifiedByType |
LastModifiedByType: The type of identity that last modified the resource. |
UserAssignedIdentityProperties
(Appears on:KeyVaultProperties)
Generated from: https://schema.management.azure.com/schemas/2021-01-01-preview/Microsoft.ServiceBus.json#/definitions/UserAssignedIdentityProperties
Field | Description |
---|---|
userAssignedIdentityReference genruntime.ResourceReference |
UserAssignedIdentityReference: ARM ID of user Identity selected for encryption |
UserAssignedIdentityPropertiesARM
(Appears on:KeyVaultPropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-01-01-preview/Microsoft.ServiceBus.json#/definitions/UserAssignedIdentityProperties
Field | Description |
---|---|
userAssignedIdentity string |
UserAssignedIdentityProperties_Status
(Appears on:KeyVaultProperties_Status)
Field | Description |
---|---|
userAssignedIdentity string |
UserAssignedIdentity: ARM ID of user Identity selected for encryption |
UserAssignedIdentityProperties_StatusARM
(Appears on:KeyVaultProperties_StatusARM)
Field | Description |
---|---|
userAssignedIdentity string |
UserAssignedIdentity: ARM ID of user Identity selected for encryption |