servicebus.azure.com/v1api20211101
servicebus.azure.com/v1api20211101
Package v1api20211101 contains API Schema definitions for the servicebus v1api20211101 API group
APIVersion
(string
alias)
Value | Description |
---|---|
"2021-11-01" |
Action
(Appears on:NamespacesTopicsSubscriptionsRule_Spec)
Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression.
Field | Description |
---|---|
compatibilityLevel int |
CompatibilityLevel: This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20. |
requiresPreprocessing bool |
RequiresPreprocessing: Value that indicates whether the rule action requires preprocessing. |
sqlExpression string |
SqlExpression: SQL expression. e.g. MyProperty=‘ABC’ |
Action_STATUS
(Appears on:NamespacesTopicsSubscriptionsRule_STATUS)
Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression.
Field | Description |
---|---|
compatibilityLevel int |
CompatibilityLevel: This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20. |
requiresPreprocessing bool |
RequiresPreprocessing: Value that indicates whether the rule action requires preprocessing. |
sqlExpression string |
SqlExpression: SQL expression. e.g. MyProperty=‘ABC’ |
CorrelationFilter
(Appears on:NamespacesTopicsSubscriptionsRule_Spec)
Represents the correlation filter expression.
Field | Description |
---|---|
contentType string |
ContentType: Content type of the message. |
correlationId string |
CorrelationId: Identifier of the correlation. |
label string |
Label: Application specific label. |
messageId string |
MessageId: Identifier of the message. |
properties map[string]string |
Properties: dictionary object for custom filters |
replyTo string |
ReplyTo: Address of the queue to reply to. |
replyToSessionId string |
ReplyToSessionId: Session identifier to reply to. |
requiresPreprocessing bool |
RequiresPreprocessing: Value that indicates whether the rule action requires preprocessing. |
sessionId string |
SessionId: Session identifier. |
to string |
To: Address to send to. |
CorrelationFilter_STATUS
(Appears on:NamespacesTopicsSubscriptionsRule_STATUS)
Represents the correlation filter expression.
Field | Description |
---|---|
contentType string |
ContentType: Content type of the message. |
correlationId string |
CorrelationId: Identifier of the correlation. |
label string |
Label: Application specific label. |
messageId string |
MessageId: Identifier of the message. |
properties map[string]string |
Properties: dictionary object for custom filters |
replyTo string |
ReplyTo: Address of the queue to reply to. |
replyToSessionId string |
ReplyToSessionId: Session identifier to reply to. |
requiresPreprocessing bool |
RequiresPreprocessing: Value that indicates whether the rule action requires preprocessing. |
sessionId string |
SessionId: Session identifier. |
to string |
To: Address to send to. |
Encryption
(Appears on:Namespace_Spec)
Properties to configure Encryption
Field | Description |
---|---|
keySource Encryption_KeySource |
KeySource: Enumerates the possible value of keySource for Encryption |
keyVaultProperties []KeyVaultProperties |
KeyVaultProperties: Properties of KeyVault |
requireInfrastructureEncryption bool |
RequireInfrastructureEncryption: Enable Infrastructure Encryption (Double Encryption) |
Encryption_KeySource
(string
alias)
(Appears on:Encryption)
Value | Description |
---|---|
"Microsoft.KeyVault" |
Encryption_KeySource_STATUS
(string
alias)
(Appears on:Encryption_STATUS)
Value | Description |
---|---|
"Microsoft.KeyVault" |
Encryption_STATUS
(Appears on:Namespace_STATUS)
Properties to configure Encryption
Field | Description |
---|---|
keySource Encryption_KeySource_STATUS |
KeySource: Enumerates the possible value of keySource for Encryption |
keyVaultProperties []KeyVaultProperties_STATUS |
KeyVaultProperties: Properties of KeyVault |
requireInfrastructureEncryption bool |
RequireInfrastructureEncryption: Enable Infrastructure Encryption (Double Encryption) |
EntityStatus_STATUS
(string
alias)
(Appears on:NamespacesQueue_STATUS, NamespacesTopic_STATUS, NamespacesTopicsSubscription_STATUS)
Entity status.
Value | Description |
---|---|
"Active" |
|
"Creating" |
|
"Deleting" |
|
"Disabled" |
|
"ReceiveDisabled" |
|
"Renaming" |
|
"Restoring" |
|
"SendDisabled" |
|
"Unknown" |
FilterType
(string
alias)
(Appears on:NamespacesTopicsSubscriptionsRule_Spec)
Rule filter types
Value | Description |
---|---|
"CorrelationFilter" |
|
"SqlFilter" |
FilterType_STATUS
(string
alias)
(Appears on:NamespacesTopicsSubscriptionsRule_STATUS)
Rule filter types
Value | Description |
---|---|
"CorrelationFilter" |
|
"SqlFilter" |
Identity
(Appears on:Namespace_Spec)
Properties to configure User Assigned Identities for Bring your Own Keys
Field | Description |
---|---|
type Identity_Type |
Type: Type of managed service identity. |
userAssignedIdentities []UserAssignedIdentityDetails |
UserAssignedIdentities: Properties for User Assigned Identities |
Identity_STATUS
(Appears on:Namespace_STATUS)
Properties to configure User Assigned Identities for Bring your Own Keys
Field | Description |
---|---|
principalId string |
PrincipalId: ObjectId from the KeyVault |
tenantId string |
TenantId: TenantId from the KeyVault |
type Identity_Type_STATUS |
Type: Type of managed service identity. |
userAssignedIdentities map[string]./api/servicebus/v1api20211101.UserAssignedIdentity_STATUS |
UserAssignedIdentities: Properties for User Assigned Identities |
Identity_Type
(string
alias)
(Appears on:Identity)
Value | Description |
---|---|
"None" |
|
"SystemAssigned" |
|
"SystemAssigned, UserAssigned" |
|
"UserAssigned" |
Identity_Type_STATUS
(string
alias)
(Appears on:Identity_STATUS)
Value | Description |
---|---|
"None" |
|
"SystemAssigned" |
|
"SystemAssigned, UserAssigned" |
|
"UserAssigned" |
KeyVaultProperties
(Appears on:Encryption)
Properties to configure keyVault Properties
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 |
KeyVaultProperties_STATUS
(Appears on:Encryption_STATUS)
Properties to configure keyVault Properties
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 |
MessageCountDetails_STATUS
(Appears on:NamespacesQueue_STATUS, NamespacesTopic_STATUS, NamespacesTopicsSubscription_STATUS)
Message Count Details.
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
Generator information: - Generated from: /servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/namespace-preview.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}p>
Field | Description | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||
spec Namespace_Spec |
|
||||||||||||||||||||||
status Namespace_STATUS |
NamespaceOperatorSecrets
(Appears on:NamespaceOperatorSpec)
Field | Description |
---|---|
endpoint genruntime.SecretDestination |
Endpoint: indicates where the Endpoint secret should be placed. If omitted, the secret will not be retrieved from Azure. |
primaryConnectionString genruntime.SecretDestination |
PrimaryConnectionString: indicates where the PrimaryConnectionString secret should be placed. If omitted, the secret will not be retrieved from Azure. |
primaryKey genruntime.SecretDestination |
PrimaryKey: indicates where the PrimaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure. |
secondaryConnectionString genruntime.SecretDestination |
SecondaryConnectionString: indicates where the SecondaryConnectionString secret should be placed. If omitted, the secret will not be retrieved from Azure. |
secondaryKey genruntime.SecretDestination |
SecondaryKey: indicates where the SecondaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure. |
NamespaceOperatorSpec
(Appears on:Namespace_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
secrets NamespaceOperatorSecrets |
Secrets: configures where to place Azure generated secrets. |
Namespace_STATUS
(Appears on:Namespace)
Field | Description |
---|---|
alternateName string |
AlternateName: Alternate name for namespace |
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
createdAt string |
CreatedAt: The time the namespace was created |
disableLocalAuth bool |
DisableLocalAuth: This property disables SAS authentication for the Service Bus namespace. |
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 |
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. |
Namespace_Spec
(Appears on:Namespace)
Field | Description |
---|---|
alternateName string |
AlternateName: Alternate name for namespace |
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. |
disableLocalAuth bool |
DisableLocalAuth: This property disables SAS authentication for the Service Bus namespace. |
encryption Encryption |
Encryption: Properties of BYOK Encryption description |
identity Identity |
Identity: Properties of BYOK Identity description |
location string |
Location: The Geo-location where the resource lives |
operatorSpec NamespaceOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
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: Properties of SKU |
tags map[string]string |
Tags: Resource tags |
zoneRedundant bool |
ZoneRedundant: Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones. |
NamespacesAuthorizationRule
Generator information: - Generated from: /servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/AuthorizationRules.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}p>
Field | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||
spec NamespacesAuthorizationRule_Spec |
|
||||||||
status NamespacesAuthorizationRule_STATUS |
NamespacesAuthorizationRuleOperatorSecrets
(Appears on:NamespacesAuthorizationRuleOperatorSpec)
Field | Description |
---|---|
primaryConnectionString genruntime.SecretDestination |
PrimaryConnectionString: indicates where the PrimaryConnectionString secret should be placed. If omitted, the secret will not be retrieved from Azure. |
primaryKey genruntime.SecretDestination |
PrimaryKey: indicates where the PrimaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure. |
secondaryConnectionString genruntime.SecretDestination |
SecondaryConnectionString: indicates where the SecondaryConnectionString secret should be placed. If omitted, the secret will not be retrieved from Azure. |
secondaryKey genruntime.SecretDestination |
SecondaryKey: indicates where the SecondaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure. |
NamespacesAuthorizationRuleOperatorSpec
(Appears on:NamespacesAuthorizationRule_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
secrets NamespacesAuthorizationRuleOperatorSecrets |
Secrets: configures where to place Azure generated secrets. |
NamespacesAuthorizationRule_STATUS
(Appears on:NamespacesAuthorizationRule)
Field | Description |
---|---|
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
location string |
Location: The geo-location where the resource lives |
name string |
Name: The name of the resource |
rights []Namespaces_AuthorizationRule_Properties_Rights_STATUS |
Rights: The rights associated with the rule. |
systemData SystemData_STATUS |
SystemData: The system meta data relating to this resource. |
type string |
Type: The type of the resource. E.g. “Microsoft.EventHub/Namespaces” or “Microsoft.EventHub/Namespaces/EventHubs” |
NamespacesAuthorizationRule_Spec
(Appears on:NamespacesAuthorizationRule)
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. |
operatorSpec NamespacesAuthorizationRuleOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
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 |
rights []Namespaces_AuthorizationRule_Properties_Rights_Spec |
Rights: The rights associated with the rule. |
NamespacesQueue
Generator information: - Generated from: /servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/Queue.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}p>
Field | Description | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||||||||||||||||
spec NamespacesQueue_Spec |
|
||||||||||||||||||||||||||||||||||||
status NamespacesQueue_STATUS |
NamespacesQueueOperatorSpec
(Appears on:NamespacesQueue_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
NamespacesQueue_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: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
location string |
Location: The geo-location where the resource lives |
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. |
maxMessageSizeInKilobytes int |
MaxMessageSizeInKilobytes: Maximum size (in KB) of the message payload that can be accepted by the queue. This property is only used in Premium today and default is 1024. |
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: The name of the 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. |
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: The type of the resource. E.g. “Microsoft.EventHub/Namespaces” or “Microsoft.EventHub/Namespaces/EventHubs” |
updatedAt string |
UpdatedAt: The exact time the message was updated. |
NamespacesQueue_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 |
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. |
maxMessageSizeInKilobytes int |
MaxMessageSizeInKilobytes: Maximum size (in KB) of the message payload that can be accepted by the queue. This property is only used in Premium today and default is 1024. |
maxSizeInMegabytes int |
MaxSizeInMegabytes: The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024. |
operatorSpec NamespacesQueueOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
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. |
NamespacesTopic
Generator information: - Generated from: /servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/topics.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}p>
Field | Description | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||||||
spec NamespacesTopic_Spec |
|
||||||||||||||||||||||||||
status NamespacesTopic_STATUS |
NamespacesTopicOperatorSpec
(Appears on:NamespacesTopic_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
NamespacesTopic_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: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
location string |
Location: The geo-location where the resource lives |
maxMessageSizeInKilobytes int |
MaxMessageSizeInKilobytes: Maximum size (in KB) of the message payload that can be accepted by the topic. This property is only used in Premium today and default is 1024. |
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: The name of the resource |
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: The type of the resource. E.g. “Microsoft.EventHub/Namespaces” or “Microsoft.EventHub/Namespaces/EventHubs” |
updatedAt string |
UpdatedAt: The exact time the message was updated. |
NamespacesTopic_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. |
maxMessageSizeInKilobytes int |
MaxMessageSizeInKilobytes: Maximum size (in KB) of the message payload that can be accepted by the topic. This property is only used in Premium today and default is 1024. |
maxSizeInMegabytes int |
MaxSizeInMegabytes: Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024. |
operatorSpec NamespacesTopicOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
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. |
NamespacesTopicsSubscription
Generator information: - Generated from: /servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/subscriptions.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}p>
Field | Description | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||||||||||||
spec NamespacesTopicsSubscription_Spec |
|
||||||||||||||||||||||||||||||||
status NamespacesTopicsSubscription_STATUS |
NamespacesTopicsSubscriptionOperatorSpec
(Appears on:NamespacesTopicsSubscription_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
NamespacesTopicsSubscription_STATUS
(Appears on:NamespacesTopicsSubscription)
Field | Description |
---|---|
accessedAt string |
AccessedAt: Last time there was a receive request to this subscription. |
autoDeleteOnIdle string |
AutoDeleteOnIdle: ISO 8061 timeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. |
clientAffineProperties SBClientAffineProperties_STATUS |
ClientAffineProperties: Properties specific to client affine subscriptions. |
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. |
deadLetteringOnFilterEvaluationExceptions bool |
DeadLetteringOnFilterEvaluationExceptions: Value that indicates whether a subscription has dead letter support on filter evaluation exceptions. |
deadLetteringOnMessageExpiration bool |
DeadLetteringOnMessageExpiration: Value that indicates whether a subscription has dead letter support when a message expires. |
defaultMessageTimeToLive string |
DefaultMessageTimeToLive: ISO 8061 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. |
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: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
isClientAffine bool |
IsClientAffine: Value that indicates whether the subscription has an affinity to the client id. |
location string |
Location: The geo-location where the resource lives |
lockDuration string |
LockDuration: ISO 8061 lock duration timespan for the subscription. The default value is 1 minute. |
maxDeliveryCount int |
MaxDeliveryCount: Number of maximum deliveries. |
messageCount int |
MessageCount: Number of messages. |
name string |
Name: The name of the resource |
requiresSession bool |
RequiresSession: Value indicating if a subscription supports the concept of sessions. |
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: The type of the resource. E.g. “Microsoft.EventHub/Namespaces” or “Microsoft.EventHub/Namespaces/EventHubs” |
updatedAt string |
UpdatedAt: The exact time the message was updated. |
NamespacesTopicsSubscription_Spec
(Appears on:NamespacesTopicsSubscription)
Field | Description |
---|---|
autoDeleteOnIdle string |
AutoDeleteOnIdle: ISO 8061 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. |
clientAffineProperties SBClientAffineProperties |
ClientAffineProperties: Properties specific to client affine subscriptions. |
deadLetteringOnFilterEvaluationExceptions bool |
DeadLetteringOnFilterEvaluationExceptions: Value that indicates whether a subscription has dead letter support on filter evaluation exceptions. |
deadLetteringOnMessageExpiration bool |
DeadLetteringOnMessageExpiration: Value that indicates whether a subscription has dead letter support when a message expires. |
defaultMessageTimeToLive string |
DefaultMessageTimeToLive: ISO 8061 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. |
forwardDeadLetteredMessagesTo string |
ForwardDeadLetteredMessagesTo: Queue/Topic name to forward the Dead Letter message |
forwardTo string |
ForwardTo: Queue/Topic name to forward the messages |
isClientAffine bool |
IsClientAffine: Value that indicates whether the subscription has an affinity to the client id. |
lockDuration string |
LockDuration: ISO 8061 lock duration timespan for the subscription. The default value is 1 minute. |
maxDeliveryCount int |
MaxDeliveryCount: Number of maximum deliveries. |
operatorSpec NamespacesTopicsSubscriptionOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
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/NamespacesTopic resource |
requiresSession bool |
RequiresSession: Value indicating if a subscription supports the concept of sessions. |
NamespacesTopicsSubscriptionsRule
Generator information: - Generated from: /servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/Rules.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}/rules/{ruleName}p>
Field | Description | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||
spec NamespacesTopicsSubscriptionsRule_Spec |
|
||||||||||||||
status NamespacesTopicsSubscriptionsRule_STATUS |
NamespacesTopicsSubscriptionsRuleOperatorSpec
(Appears on:NamespacesTopicsSubscriptionsRule_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
NamespacesTopicsSubscriptionsRule_STATUS
(Appears on:NamespacesTopicsSubscriptionsRule)
Field | Description |
---|---|
action Action_STATUS |
Action: Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression. |
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
correlationFilter CorrelationFilter_STATUS |
CorrelationFilter: Properties of correlationFilter |
filterType FilterType_STATUS |
FilterType: Filter type that is evaluated against a BrokeredMessage. |
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
location string |
Location: The geo-location where the resource lives |
name string |
Name: The name of the resource |
sqlFilter SqlFilter_STATUS |
SqlFilter: Properties of sqlFilter |
systemData SystemData_STATUS |
SystemData: The system meta data relating to this resource. |
type string |
Type: The type of the resource. E.g. “Microsoft.EventHub/Namespaces” or “Microsoft.EventHub/Namespaces/EventHubs” |
NamespacesTopicsSubscriptionsRule_Spec
(Appears on:NamespacesTopicsSubscriptionsRule)
Field | Description |
---|---|
action Action |
Action: Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression. |
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. |
correlationFilter CorrelationFilter |
CorrelationFilter: Properties of correlationFilter |
filterType FilterType |
FilterType: Filter type that is evaluated against a BrokeredMessage. |
operatorSpec NamespacesTopicsSubscriptionsRuleOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
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/NamespacesTopicsSubscription resource |
sqlFilter SqlFilter |
SqlFilter: Properties of sqlFilter |
Namespaces_AuthorizationRule_Properties_Rights_STATUS
(string
alias)
(Appears on:NamespacesAuthorizationRule_STATUS)
Value | Description |
---|---|
"Listen" |
|
"Manage" |
|
"Send" |
Namespaces_AuthorizationRule_Properties_Rights_Spec
(string
alias)
(Appears on:NamespacesAuthorizationRule_Spec)
Value | Description |
---|---|
"Listen" |
|
"Manage" |
|
"Send" |
PrivateEndpointConnection_STATUS
(Appears on:Namespace_STATUS)
Properties of the PrivateEndpointConnection.
Field | Description |
---|---|
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
SBClientAffineProperties
(Appears on:NamespacesTopicsSubscription_Spec)
Properties specific to client affine subscriptions.
Field | Description |
---|---|
clientId string |
ClientId: Indicates the Client ID of the application that created the client-affine subscription. |
isDurable bool |
IsDurable: For client-affine subscriptions, this value indicates whether the subscription is durable or not. |
isShared bool |
IsShared: For client-affine subscriptions, this value indicates whether the subscription is shared or not. |
SBClientAffineProperties_STATUS
(Appears on:NamespacesTopicsSubscription_STATUS)
Properties specific to client affine subscriptions.
Field | Description |
---|---|
clientId string |
ClientId: Indicates the Client ID of the application that created the client-affine subscription. |
isDurable bool |
IsDurable: For client-affine subscriptions, this value indicates whether the subscription is durable or not. |
isShared bool |
IsShared: For client-affine subscriptions, this value indicates whether the subscription is shared or not. |
SBSku
(Appears on:Namespace_Spec)
SKU of the namespace.
Field | Description |
---|---|
capacity int |
Capacity: The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4. |
name SBSku_Name |
Name: Name of this SKU. |
tier SBSku_Tier |
Tier: The billing tier of this particular SKU. |
SBSku_Name
(string
alias)
(Appears on:SBSku)
Value | Description |
---|---|
"Basic" |
|
"Premium" |
|
"Standard" |
SBSku_Name_STATUS
(string
alias)
(Appears on:SBSku_STATUS)
Value | Description |
---|---|
"Basic" |
|
"Premium" |
|
"Standard" |
SBSku_STATUS
(Appears on:Namespace_STATUS)
SKU of the namespace.
Field | Description |
---|---|
capacity int |
Capacity: The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4. |
name SBSku_Name_STATUS |
Name: Name of this SKU. |
tier SBSku_Tier_STATUS |
Tier: The billing tier of this particular SKU. |
SBSku_Tier
(string
alias)
(Appears on:SBSku)
Value | Description |
---|---|
"Basic" |
|
"Premium" |
|
"Standard" |
SBSku_Tier_STATUS
(string
alias)
(Appears on:SBSku_STATUS)
Value | Description |
---|---|
"Basic" |
|
"Premium" |
|
"Standard" |
SqlFilter
(Appears on:NamespacesTopicsSubscriptionsRule_Spec)
Represents a filter which is a composition of an expression and an action that is executed in the pub/sub pipeline.
Field | Description |
---|---|
compatibilityLevel int |
CompatibilityLevel: This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20. |
requiresPreprocessing bool |
RequiresPreprocessing: Value that indicates whether the rule action requires preprocessing. |
sqlExpression string |
SqlExpression: The SQL expression. e.g. MyProperty=‘ABC’ |
SqlFilter_STATUS
(Appears on:NamespacesTopicsSubscriptionsRule_STATUS)
Represents a filter which is a composition of an expression and an action that is executed in the pub/sub pipeline.
Field | Description |
---|---|
compatibilityLevel int |
CompatibilityLevel: This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20. |
requiresPreprocessing bool |
RequiresPreprocessing: Value that indicates whether the rule action requires preprocessing. |
sqlExpression string |
SqlExpression: The SQL expression. e.g. MyProperty=‘ABC’ |
SystemData_CreatedByType_STATUS
(string
alias)
(Appears on:SystemData_STATUS)
Value | Description |
---|---|
"Application" |
|
"Key" |
|
"ManagedIdentity" |
|
"User" |
SystemData_LastModifiedByType_STATUS
(string
alias)
(Appears on:SystemData_STATUS)
Value | Description |
---|---|
"Application" |
|
"Key" |
|
"ManagedIdentity" |
|
"User" |
SystemData_STATUS
(Appears on:Namespace_STATUS, NamespacesAuthorizationRule_STATUS, NamespacesQueue_STATUS, NamespacesTopic_STATUS, NamespacesTopicsSubscription_STATUS, NamespacesTopicsSubscriptionsRule_STATUS)
Metadata pertaining to creation and last modification of the resource.
Field | Description |
---|---|
createdAt string |
CreatedAt: The timestamp of resource creation (UTC). |
createdBy string |
CreatedBy: The identity that created the resource. |
createdByType SystemData_CreatedByType_STATUS |
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 SystemData_LastModifiedByType_STATUS |
LastModifiedByType: The type of identity that last modified the resource. |
UserAssignedIdentityDetails
(Appears on:Identity)
Information about the user assigned identity for the resource
Field | Description |
---|---|
reference genruntime.ResourceReference |
UserAssignedIdentityProperties
(Appears on:KeyVaultProperties)
Field | Description |
---|---|
userAssignedIdentityReference genruntime.ResourceReference |
UserAssignedIdentityReference: ARM ID of user Identity selected for encryption |
UserAssignedIdentityProperties_STATUS
(Appears on:KeyVaultProperties_STATUS)
Field | Description |
---|---|
userAssignedIdentity string |
UserAssignedIdentity: ARM ID of user Identity selected for encryption |
UserAssignedIdentity_STATUS
(Appears on:Identity_STATUS)
Recognized Dictionary value.
Field | Description |
---|---|
clientId string |
ClientId: Client Id of user assigned identity |
principalId string |
PrincipalId: Principal Id of user assigned identity |