servicebus.azure.com/v1api20211101
APIVersion
| Value | Description |
|---|---|
| “2021-11-01” |
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}
Used by: NamespaceList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | Namespace_Spec Optional |
|
| status | Namespace_STATUS Optional |
Namespace_Spec
| Property | Description | Type |
|---|---|---|
| alternateName | Alternate name for namespace | string Optional |
| 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. | string Optional |
| disableLocalAuth | This property disables SAS authentication for the Service Bus namespace. | bool Optional |
| encryption | Properties of BYOK Encryption description | Encryption Optional |
| identity | Properties of BYOK Identity description | Identity Optional |
| location | The Geo-location where the resource lives | string Required |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | NamespaceOperatorSpec Optional |
| 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 | genruntime.KnownResourceReference Required |
| sku | Properties of SKU | SBSku Optional |
| tags | Resource tags | map[string]string Optional |
| zoneRedundant | Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones. | bool Optional |
Namespace_STATUS
| Property | Description | Type |
|---|---|---|
| alternateName | Alternate name for namespace | string Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| createdAt | The time the namespace was created | string Optional |
| disableLocalAuth | This property disables SAS authentication for the Service Bus namespace. | bool Optional |
| encryption | Properties of BYOK Encryption description | Encryption_STATUS Optional |
| id | Resource Id | string Optional |
| identity | Properties of BYOK Identity description | Identity_STATUS Optional |
| location | The Geo-location where the resource lives | string Optional |
| metricId | Identifier for Azure Insights metrics | string Optional |
| name | Resource name | string Optional |
| privateEndpointConnections | List of private endpoint connections. | PrivateEndpointConnection_STATUS[] Optional |
| provisioningState | Provisioning state of the namespace. | string Optional |
| serviceBusEndpoint | Endpoint you can use to perform Service Bus operations. | string Optional |
| sku | Properties of SKU | SBSku_STATUS Optional |
| status | Status of the namespace. | string Optional |
| systemData | The system meta data relating to this resource. | SystemData_STATUS Optional |
| tags | Resource tags | map[string]string Optional |
| type | Resource type | string Optional |
| updatedAt | The time the namespace was updated. | string Optional |
| zoneRedundant | Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones. | bool Optional |
NamespaceList
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}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | Namespace[] Optional |
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}
Used by: NamespacesAuthorizationRuleList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | NamespacesAuthorizationRule_Spec Optional |
|
| status | NamespacesAuthorizationRule_STATUS Optional |
NamespacesAuthorizationRule_Spec
| Property | Description | Type |
|---|---|---|
| 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. | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | NamespacesAuthorizationRuleOperatorSpec Optional |
| 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 | genruntime.KnownResourceReference Required |
| rights | The rights associated with the rule. | Namespaces_AuthorizationRule_Properties_Rights_Spec[] Required |
NamespacesAuthorizationRule_STATUS
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| location | The geo-location where the resource lives | string Optional |
| name | The name of the resource | string Optional |
| rights | The rights associated with the rule. | Namespaces_AuthorizationRule_Properties_Rights_STATUS[] Optional |
| systemData | The system meta data relating to this resource. | SystemData_STATUS Optional |
| type | The type of the resource. E.g. “Microsoft.EventHub/Namespaces” or “Microsoft.EventHub/Namespaces/EventHubs” | string Optional |
NamespacesAuthorizationRuleList
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}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | NamespacesAuthorizationRule[] Optional |
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}
Used by: NamespacesQueueList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | NamespacesQueue_Spec Optional |
|
| status | NamespacesQueue_STATUS Optional |
NamespacesQueue_Spec
| Property | Description | Type |
|---|---|---|
| autoDeleteOnIdle | ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes. | string Optional |
| 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. | string Optional |
| deadLetteringOnMessageExpiration | A value that indicates whether this queue has dead letter support when a message expires. | bool Optional |
| 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. | string Optional |
| duplicateDetectionHistoryTimeWindow | ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. | string Optional |
| enableBatchedOperations | Value that indicates whether server-side batched operations are enabled. | bool Optional |
| 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. | bool Optional |
| enablePartitioning | A value that indicates whether the queue is to be partitioned across multiple message brokers. | bool Optional |
| forwardDeadLetteredMessagesTo | Queue/Topic name to forward the Dead Letter message | string Optional |
| forwardTo | Queue/Topic name to forward the messages | string Optional |
| 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. | string Optional |
| maxDeliveryCount | The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10. | int Optional |
| 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. | int Optional |
| maxSizeInMegabytes | The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024. | int Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | NamespacesQueueOperatorSpec Optional |
| 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 | genruntime.KnownResourceReference Required |
| requiresDuplicateDetection | A value indicating if this queue requires duplicate detection. | bool Optional |
| requiresSession | A value that indicates whether the queue supports the concept of sessions. | bool Optional |
NamespacesQueue_STATUS
| Property | Description | Type |
|---|---|---|
| accessedAt | Last time a message was sent, or the last time there was a receive request to this queue. | string Optional |
| autoDeleteOnIdle | ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes. | string Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| countDetails | Message Count Details. | MessageCountDetails_STATUS Optional |
| createdAt | The exact time the message was created. | string Optional |
| deadLetteringOnMessageExpiration | A value that indicates whether this queue has dead letter support when a message expires. | bool Optional |
| 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. | string Optional |
| duplicateDetectionHistoryTimeWindow | ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. | string Optional |
| enableBatchedOperations | Value that indicates whether server-side batched operations are enabled. | bool Optional |
| 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. | bool Optional |
| enablePartitioning | A value that indicates whether the queue is to be partitioned across multiple message brokers. | bool Optional |
| forwardDeadLetteredMessagesTo | Queue/Topic name to forward the Dead Letter message | string Optional |
| forwardTo | Queue/Topic name to forward the messages | string Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| location | The geo-location where the resource lives | string Optional |
| 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. | string Optional |
| maxDeliveryCount | The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10. | int Optional |
| 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. | int Optional |
| maxSizeInMegabytes | The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024. | int Optional |
| messageCount | The number of messages in the queue. | int Optional |
| name | The name of the resource | string Optional |
| requiresDuplicateDetection | A value indicating if this queue requires duplicate detection. | bool Optional |
| requiresSession | A value that indicates whether the queue supports the concept of sessions. | bool Optional |
| sizeInBytes | The size of the queue, in bytes. | int Optional |
| status | Enumerates the possible values for the status of a messaging entity. | EntityStatus_STATUS Optional |
| systemData | The system meta data relating to this resource. | SystemData_STATUS Optional |
| type | The type of the resource. E.g. “Microsoft.EventHub/Namespaces” or “Microsoft.EventHub/Namespaces/EventHubs” | string Optional |
| updatedAt | The exact time the message was updated. | string Optional |
NamespacesQueueList
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}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | NamespacesQueue[] Optional |
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}
Used by: NamespacesTopicList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | NamespacesTopic_Spec Optional |
|
| status | NamespacesTopic_STATUS Optional |
NamespacesTopic_Spec
| Property | Description | Type |
|---|---|---|
| autoDeleteOnIdle | ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. | string Optional |
| 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. | string Optional |
| 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. | string Optional |
| duplicateDetectionHistoryTimeWindow | ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. | string Optional |
| enableBatchedOperations | Value that indicates whether server-side batched operations are enabled. | bool Optional |
| enableExpress | Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage. | bool Optional |
| enablePartitioning | Value that indicates whether the topic to be partitioned across multiple message brokers is enabled. | bool Optional |
| 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. | int Optional |
| maxSizeInMegabytes | Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024. | int Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | NamespacesTopicOperatorSpec Optional |
| 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 | genruntime.KnownResourceReference Required |
| requiresDuplicateDetection | Value indicating if this topic requires duplicate detection. | bool Optional |
| supportOrdering | Value that indicates whether the topic supports ordering. | bool Optional |
NamespacesTopic_STATUS
| Property | Description | Type |
|---|---|---|
| accessedAt | Last time the message was sent, or a request was received, for this topic. | string Optional |
| autoDeleteOnIdle | ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. | string Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| countDetails | Message count details | MessageCountDetails_STATUS Optional |
| createdAt | Exact time the message was created. | string Optional |
| 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. | string Optional |
| duplicateDetectionHistoryTimeWindow | ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. | string Optional |
| enableBatchedOperations | Value that indicates whether server-side batched operations are enabled. | bool Optional |
| enableExpress | Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage. | bool Optional |
| enablePartitioning | Value that indicates whether the topic to be partitioned across multiple message brokers is enabled. | bool Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| location | The geo-location where the resource lives | string Optional |
| 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. | int Optional |
| maxSizeInMegabytes | Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024. | int Optional |
| name | The name of the resource | string Optional |
| requiresDuplicateDetection | Value indicating if this topic requires duplicate detection. | bool Optional |
| sizeInBytes | Size of the topic, in bytes. | int Optional |
| status | Enumerates the possible values for the status of a messaging entity. | EntityStatus_STATUS Optional |
| subscriptionCount | Number of subscriptions. | int Optional |
| supportOrdering | Value that indicates whether the topic supports ordering. | bool Optional |
| systemData | The system meta data relating to this resource. | SystemData_STATUS Optional |
| type | The type of the resource. E.g. “Microsoft.EventHub/Namespaces” or “Microsoft.EventHub/Namespaces/EventHubs” | string Optional |
| updatedAt | The exact time the message was updated. | string Optional |
NamespacesTopicList
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}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | NamespacesTopic[] Optional |
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}
Used by: NamespacesTopicsSubscriptionList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | NamespacesTopicsSubscription_Spec Optional |
|
| status | NamespacesTopicsSubscription_STATUS Optional |
NamespacesTopicsSubscription_Spec
| Property | Description | Type |
|---|---|---|
| autoDeleteOnIdle | ISO 8061 timeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. | string Optional |
| 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. | string Optional |
| clientAffineProperties | Properties specific to client affine subscriptions. | SBClientAffineProperties Optional |
| deadLetteringOnFilterEvaluationExceptions | Value that indicates whether a subscription has dead letter support on filter evaluation exceptions. | bool Optional |
| deadLetteringOnMessageExpiration | Value that indicates whether a subscription has dead letter support when a message expires. | bool Optional |
| 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. | string Optional |
| duplicateDetectionHistoryTimeWindow | ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. | string Optional |
| enableBatchedOperations | Value that indicates whether server-side batched operations are enabled. | bool Optional |
| forwardDeadLetteredMessagesTo | Queue/Topic name to forward the Dead Letter message | string Optional |
| forwardTo | Queue/Topic name to forward the messages | string Optional |
| isClientAffine | Value that indicates whether the subscription has an affinity to the client id. | bool Optional |
| lockDuration | ISO 8061 lock duration timespan for the subscription. The default value is 1 minute. | string Optional |
| maxDeliveryCount | Number of maximum deliveries. | int Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | NamespacesTopicsSubscriptionOperatorSpec Optional |
| 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 | genruntime.KnownResourceReference Required |
| requiresSession | Value indicating if a subscription supports the concept of sessions. | bool Optional |
NamespacesTopicsSubscription_STATUS
| Property | Description | Type |
|---|---|---|
| accessedAt | Last time there was a receive request to this subscription. | string Optional |
| autoDeleteOnIdle | ISO 8061 timeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. | string Optional |
| clientAffineProperties | Properties specific to client affine subscriptions. | SBClientAffineProperties_STATUS Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| countDetails | Message count details | MessageCountDetails_STATUS Optional |
| createdAt | Exact time the message was created. | string Optional |
| deadLetteringOnFilterEvaluationExceptions | Value that indicates whether a subscription has dead letter support on filter evaluation exceptions. | bool Optional |
| deadLetteringOnMessageExpiration | Value that indicates whether a subscription has dead letter support when a message expires. | bool Optional |
| 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. | string Optional |
| duplicateDetectionHistoryTimeWindow | ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. | string Optional |
| enableBatchedOperations | Value that indicates whether server-side batched operations are enabled. | bool Optional |
| forwardDeadLetteredMessagesTo | Queue/Topic name to forward the Dead Letter message | string Optional |
| forwardTo | Queue/Topic name to forward the messages | string Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| isClientAffine | Value that indicates whether the subscription has an affinity to the client id. | bool Optional |
| location | The geo-location where the resource lives | string Optional |
| lockDuration | ISO 8061 lock duration timespan for the subscription. The default value is 1 minute. | string Optional |
| maxDeliveryCount | Number of maximum deliveries. | int Optional |
| messageCount | Number of messages. | int Optional |
| name | The name of the resource | string Optional |
| requiresSession | Value indicating if a subscription supports the concept of sessions. | bool Optional |
| status | Enumerates the possible values for the status of a messaging entity. | EntityStatus_STATUS Optional |
| systemData | The system meta data relating to this resource. | SystemData_STATUS Optional |
| type | The type of the resource. E.g. “Microsoft.EventHub/Namespaces” or “Microsoft.EventHub/Namespaces/EventHubs” | string Optional |
| updatedAt | The exact time the message was updated. | string Optional |
NamespacesTopicsSubscriptionList
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}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | NamespacesTopicsSubscription[] Optional |
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}
Used by: NamespacesTopicsSubscriptionsRuleList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | NamespacesTopicsSubscriptionsRule_Spec Optional |
|
| status | NamespacesTopicsSubscriptionsRule_STATUS Optional |
NamespacesTopicsSubscriptionsRule_Spec
| Property | Description | Type |
|---|---|---|
| action | Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression. | Action Optional |
| 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. | string Optional |
| correlationFilter | Properties of correlationFilter | CorrelationFilter Optional |
| filterType | Filter type that is evaluated against a BrokeredMessage. | FilterType Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | NamespacesTopicsSubscriptionsRuleOperatorSpec Optional |
| 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 | genruntime.KnownResourceReference Required |
| sqlFilter | Properties of sqlFilter | SqlFilter Optional |
NamespacesTopicsSubscriptionsRule_STATUS
| Property | Description | Type |
|---|---|---|
| action | Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression. | Action_STATUS Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| correlationFilter | Properties of correlationFilter | CorrelationFilter_STATUS Optional |
| filterType | Filter type that is evaluated against a BrokeredMessage. | FilterType_STATUS Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| location | The geo-location where the resource lives | string Optional |
| name | The name of the resource | string Optional |
| sqlFilter | Properties of sqlFilter | SqlFilter_STATUS Optional |
| systemData | The system meta data relating to this resource. | SystemData_STATUS Optional |
| type | The type of the resource. E.g. “Microsoft.EventHub/Namespaces” or “Microsoft.EventHub/Namespaces/EventHubs” | string Optional |
NamespacesTopicsSubscriptionsRuleList
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}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | NamespacesTopicsSubscriptionsRule[] Optional |
Namespace_Spec
Used by: Namespace.
| Property | Description | Type |
|---|---|---|
| alternateName | Alternate name for namespace | string Optional |
| 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. | string Optional |
| disableLocalAuth | This property disables SAS authentication for the Service Bus namespace. | bool Optional |
| encryption | Properties of BYOK Encryption description | Encryption Optional |
| identity | Properties of BYOK Identity description | Identity Optional |
| location | The Geo-location where the resource lives | string Required |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | NamespaceOperatorSpec Optional |
| 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 | genruntime.KnownResourceReference Required |
| sku | Properties of SKU | SBSku Optional |
| tags | Resource tags | map[string]string Optional |
| zoneRedundant | Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones. | bool Optional |
Namespace_STATUS
Used by: Namespace.
| Property | Description | Type |
|---|---|---|
| alternateName | Alternate name for namespace | string Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| createdAt | The time the namespace was created | string Optional |
| disableLocalAuth | This property disables SAS authentication for the Service Bus namespace. | bool Optional |
| encryption | Properties of BYOK Encryption description | Encryption_STATUS Optional |
| id | Resource Id | string Optional |
| identity | Properties of BYOK Identity description | Identity_STATUS Optional |
| location | The Geo-location where the resource lives | string Optional |
| metricId | Identifier for Azure Insights metrics | string Optional |
| name | Resource name | string Optional |
| privateEndpointConnections | List of private endpoint connections. | PrivateEndpointConnection_STATUS[] Optional |
| provisioningState | Provisioning state of the namespace. | string Optional |
| serviceBusEndpoint | Endpoint you can use to perform Service Bus operations. | string Optional |
| sku | Properties of SKU | SBSku_STATUS Optional |
| status | Status of the namespace. | string Optional |
| systemData | The system meta data relating to this resource. | SystemData_STATUS Optional |
| tags | Resource tags | map[string]string Optional |
| type | Resource type | string Optional |
| updatedAt | The time the namespace was updated. | string Optional |
| zoneRedundant | Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones. | bool Optional |
NamespacesAuthorizationRule_Spec
Used by: NamespacesAuthorizationRule.
| Property | Description | Type |
|---|---|---|
| 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. | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | NamespacesAuthorizationRuleOperatorSpec Optional |
| 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 | genruntime.KnownResourceReference Required |
| rights | The rights associated with the rule. | Namespaces_AuthorizationRule_Properties_Rights_Spec[] Required |
NamespacesAuthorizationRule_STATUS
Used by: NamespacesAuthorizationRule.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| location | The geo-location where the resource lives | string Optional |
| name | The name of the resource | string Optional |
| rights | The rights associated with the rule. | Namespaces_AuthorizationRule_Properties_Rights_STATUS[] Optional |
| systemData | The system meta data relating to this resource. | SystemData_STATUS Optional |
| type | The type of the resource. E.g. “Microsoft.EventHub/Namespaces” or “Microsoft.EventHub/Namespaces/EventHubs” | string Optional |
NamespacesQueue_Spec
Used by: NamespacesQueue.
| Property | Description | Type |
|---|---|---|
| autoDeleteOnIdle | ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes. | string Optional |
| 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. | string Optional |
| deadLetteringOnMessageExpiration | A value that indicates whether this queue has dead letter support when a message expires. | bool Optional |
| 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. | string Optional |
| duplicateDetectionHistoryTimeWindow | ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. | string Optional |
| enableBatchedOperations | Value that indicates whether server-side batched operations are enabled. | bool Optional |
| 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. | bool Optional |
| enablePartitioning | A value that indicates whether the queue is to be partitioned across multiple message brokers. | bool Optional |
| forwardDeadLetteredMessagesTo | Queue/Topic name to forward the Dead Letter message | string Optional |
| forwardTo | Queue/Topic name to forward the messages | string Optional |
| 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. | string Optional |
| maxDeliveryCount | The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10. | int Optional |
| 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. | int Optional |
| maxSizeInMegabytes | The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024. | int Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | NamespacesQueueOperatorSpec Optional |
| 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 | genruntime.KnownResourceReference Required |
| requiresDuplicateDetection | A value indicating if this queue requires duplicate detection. | bool Optional |
| requiresSession | A value that indicates whether the queue supports the concept of sessions. | bool Optional |
NamespacesQueue_STATUS
Used by: NamespacesQueue.
| Property | Description | Type |
|---|---|---|
| accessedAt | Last time a message was sent, or the last time there was a receive request to this queue. | string Optional |
| autoDeleteOnIdle | ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes. | string Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| countDetails | Message Count Details. | MessageCountDetails_STATUS Optional |
| createdAt | The exact time the message was created. | string Optional |
| deadLetteringOnMessageExpiration | A value that indicates whether this queue has dead letter support when a message expires. | bool Optional |
| 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. | string Optional |
| duplicateDetectionHistoryTimeWindow | ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. | string Optional |
| enableBatchedOperations | Value that indicates whether server-side batched operations are enabled. | bool Optional |
| 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. | bool Optional |
| enablePartitioning | A value that indicates whether the queue is to be partitioned across multiple message brokers. | bool Optional |
| forwardDeadLetteredMessagesTo | Queue/Topic name to forward the Dead Letter message | string Optional |
| forwardTo | Queue/Topic name to forward the messages | string Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| location | The geo-location where the resource lives | string Optional |
| 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. | string Optional |
| maxDeliveryCount | The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10. | int Optional |
| 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. | int Optional |
| maxSizeInMegabytes | The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024. | int Optional |
| messageCount | The number of messages in the queue. | int Optional |
| name | The name of the resource | string Optional |
| requiresDuplicateDetection | A value indicating if this queue requires duplicate detection. | bool Optional |
| requiresSession | A value that indicates whether the queue supports the concept of sessions. | bool Optional |
| sizeInBytes | The size of the queue, in bytes. | int Optional |
| status | Enumerates the possible values for the status of a messaging entity. | EntityStatus_STATUS Optional |
| systemData | The system meta data relating to this resource. | SystemData_STATUS Optional |
| type | The type of the resource. E.g. “Microsoft.EventHub/Namespaces” or “Microsoft.EventHub/Namespaces/EventHubs” | string Optional |
| updatedAt | The exact time the message was updated. | string Optional |
NamespacesTopic_Spec
Used by: NamespacesTopic.
| Property | Description | Type |
|---|---|---|
| autoDeleteOnIdle | ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. | string Optional |
| 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. | string Optional |
| 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. | string Optional |
| duplicateDetectionHistoryTimeWindow | ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. | string Optional |
| enableBatchedOperations | Value that indicates whether server-side batched operations are enabled. | bool Optional |
| enableExpress | Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage. | bool Optional |
| enablePartitioning | Value that indicates whether the topic to be partitioned across multiple message brokers is enabled. | bool Optional |
| 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. | int Optional |
| maxSizeInMegabytes | Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024. | int Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | NamespacesTopicOperatorSpec Optional |
| 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 | genruntime.KnownResourceReference Required |
| requiresDuplicateDetection | Value indicating if this topic requires duplicate detection. | bool Optional |
| supportOrdering | Value that indicates whether the topic supports ordering. | bool Optional |
NamespacesTopic_STATUS
Used by: NamespacesTopic.
| Property | Description | Type |
|---|---|---|
| accessedAt | Last time the message was sent, or a request was received, for this topic. | string Optional |
| autoDeleteOnIdle | ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. | string Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| countDetails | Message count details | MessageCountDetails_STATUS Optional |
| createdAt | Exact time the message was created. | string Optional |
| 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. | string Optional |
| duplicateDetectionHistoryTimeWindow | ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. | string Optional |
| enableBatchedOperations | Value that indicates whether server-side batched operations are enabled. | bool Optional |
| enableExpress | Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage. | bool Optional |
| enablePartitioning | Value that indicates whether the topic to be partitioned across multiple message brokers is enabled. | bool Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| location | The geo-location where the resource lives | string Optional |
| 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. | int Optional |
| maxSizeInMegabytes | Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024. | int Optional |
| name | The name of the resource | string Optional |
| requiresDuplicateDetection | Value indicating if this topic requires duplicate detection. | bool Optional |
| sizeInBytes | Size of the topic, in bytes. | int Optional |
| status | Enumerates the possible values for the status of a messaging entity. | EntityStatus_STATUS Optional |
| subscriptionCount | Number of subscriptions. | int Optional |
| supportOrdering | Value that indicates whether the topic supports ordering. | bool Optional |
| systemData | The system meta data relating to this resource. | SystemData_STATUS Optional |
| type | The type of the resource. E.g. “Microsoft.EventHub/Namespaces” or “Microsoft.EventHub/Namespaces/EventHubs” | string Optional |
| updatedAt | The exact time the message was updated. | string Optional |
NamespacesTopicsSubscription_Spec
Used by: NamespacesTopicsSubscription.
| Property | Description | Type |
|---|---|---|
| autoDeleteOnIdle | ISO 8061 timeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. | string Optional |
| 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. | string Optional |
| clientAffineProperties | Properties specific to client affine subscriptions. | SBClientAffineProperties Optional |
| deadLetteringOnFilterEvaluationExceptions | Value that indicates whether a subscription has dead letter support on filter evaluation exceptions. | bool Optional |
| deadLetteringOnMessageExpiration | Value that indicates whether a subscription has dead letter support when a message expires. | bool Optional |
| 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. | string Optional |
| duplicateDetectionHistoryTimeWindow | ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. | string Optional |
| enableBatchedOperations | Value that indicates whether server-side batched operations are enabled. | bool Optional |
| forwardDeadLetteredMessagesTo | Queue/Topic name to forward the Dead Letter message | string Optional |
| forwardTo | Queue/Topic name to forward the messages | string Optional |
| isClientAffine | Value that indicates whether the subscription has an affinity to the client id. | bool Optional |
| lockDuration | ISO 8061 lock duration timespan for the subscription. The default value is 1 minute. | string Optional |
| maxDeliveryCount | Number of maximum deliveries. | int Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | NamespacesTopicsSubscriptionOperatorSpec Optional |
| 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 | genruntime.KnownResourceReference Required |
| requiresSession | Value indicating if a subscription supports the concept of sessions. | bool Optional |
NamespacesTopicsSubscription_STATUS
Used by: NamespacesTopicsSubscription.
| Property | Description | Type |
|---|---|---|
| accessedAt | Last time there was a receive request to this subscription. | string Optional |
| autoDeleteOnIdle | ISO 8061 timeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. | string Optional |
| clientAffineProperties | Properties specific to client affine subscriptions. | SBClientAffineProperties_STATUS Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| countDetails | Message count details | MessageCountDetails_STATUS Optional |
| createdAt | Exact time the message was created. | string Optional |
| deadLetteringOnFilterEvaluationExceptions | Value that indicates whether a subscription has dead letter support on filter evaluation exceptions. | bool Optional |
| deadLetteringOnMessageExpiration | Value that indicates whether a subscription has dead letter support when a message expires. | bool Optional |
| 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. | string Optional |
| duplicateDetectionHistoryTimeWindow | ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. | string Optional |
| enableBatchedOperations | Value that indicates whether server-side batched operations are enabled. | bool Optional |
| forwardDeadLetteredMessagesTo | Queue/Topic name to forward the Dead Letter message | string Optional |
| forwardTo | Queue/Topic name to forward the messages | string Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| isClientAffine | Value that indicates whether the subscription has an affinity to the client id. | bool Optional |
| location | The geo-location where the resource lives | string Optional |
| lockDuration | ISO 8061 lock duration timespan for the subscription. The default value is 1 minute. | string Optional |
| maxDeliveryCount | Number of maximum deliveries. | int Optional |
| messageCount | Number of messages. | int Optional |
| name | The name of the resource | string Optional |
| requiresSession | Value indicating if a subscription supports the concept of sessions. | bool Optional |
| status | Enumerates the possible values for the status of a messaging entity. | EntityStatus_STATUS Optional |
| systemData | The system meta data relating to this resource. | SystemData_STATUS Optional |
| type | The type of the resource. E.g. “Microsoft.EventHub/Namespaces” or “Microsoft.EventHub/Namespaces/EventHubs” | string Optional |
| updatedAt | The exact time the message was updated. | string Optional |
NamespacesTopicsSubscriptionsRule_Spec
Used by: NamespacesTopicsSubscriptionsRule.
| Property | Description | Type |
|---|---|---|
| action | Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression. | Action Optional |
| 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. | string Optional |
| correlationFilter | Properties of correlationFilter | CorrelationFilter Optional |
| filterType | Filter type that is evaluated against a BrokeredMessage. | FilterType Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | NamespacesTopicsSubscriptionsRuleOperatorSpec Optional |
| 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 | genruntime.KnownResourceReference Required |
| sqlFilter | Properties of sqlFilter | SqlFilter Optional |
NamespacesTopicsSubscriptionsRule_STATUS
Used by: NamespacesTopicsSubscriptionsRule.
| Property | Description | Type |
|---|---|---|
| action | Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression. | Action_STATUS Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| correlationFilter | Properties of correlationFilter | CorrelationFilter_STATUS Optional |
| filterType | Filter type that is evaluated against a BrokeredMessage. | FilterType_STATUS Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| location | The geo-location where the resource lives | string Optional |
| name | The name of the resource | string Optional |
| sqlFilter | Properties of sqlFilter | SqlFilter_STATUS Optional |
| systemData | The system meta data relating to this resource. | SystemData_STATUS Optional |
| type | The type of the resource. E.g. “Microsoft.EventHub/Namespaces” or “Microsoft.EventHub/Namespaces/EventHubs” | string Optional |
Action
Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression.
Used by: NamespacesTopicsSubscriptionsRule_Spec.
| Property | Description | Type |
|---|---|---|
| compatibilityLevel | This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20. | int Optional |
| requiresPreprocessing | Value that indicates whether the rule action requires preprocessing. | bool Optional |
| sqlExpression | SQL expression. e.g. MyProperty=‘ABC’ | string Optional |
Action_STATUS
Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression.
Used by: NamespacesTopicsSubscriptionsRule_STATUS.
| Property | Description | Type |
|---|---|---|
| compatibilityLevel | This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20. | int Optional |
| requiresPreprocessing | Value that indicates whether the rule action requires preprocessing. | bool Optional |
| sqlExpression | SQL expression. e.g. MyProperty=‘ABC’ | string Optional |
CorrelationFilter
Represents the correlation filter expression.
Used by: NamespacesTopicsSubscriptionsRule_Spec.
| Property | Description | Type |
|---|---|---|
| contentType | Content type of the message. | string Optional |
| correlationId | Identifier of the correlation. | string Optional |
| label | Application specific label. | string Optional |
| messageId | Identifier of the message. | string Optional |
| properties | dictionary object for custom filters | map[string]string Optional |
| replyTo | Address of the queue to reply to. | string Optional |
| replyToSessionId | Session identifier to reply to. | string Optional |
| requiresPreprocessing | Value that indicates whether the rule action requires preprocessing. | bool Optional |
| sessionId | Session identifier. | string Optional |
| to | Address to send to. | string Optional |
CorrelationFilter_STATUS
Represents the correlation filter expression.
Used by: NamespacesTopicsSubscriptionsRule_STATUS.
| Property | Description | Type |
|---|---|---|
| contentType | Content type of the message. | string Optional |
| correlationId | Identifier of the correlation. | string Optional |
| label | Application specific label. | string Optional |
| messageId | Identifier of the message. | string Optional |
| properties | dictionary object for custom filters | map[string]string Optional |
| replyTo | Address of the queue to reply to. | string Optional |
| replyToSessionId | Session identifier to reply to. | string Optional |
| requiresPreprocessing | Value that indicates whether the rule action requires preprocessing. | bool Optional |
| sessionId | Session identifier. | string Optional |
| to | Address to send to. | string Optional |
Encryption
Properties to configure Encryption
Used by: Namespace_Spec.
| Property | Description | Type |
|---|---|---|
| keySource | Enumerates the possible value of keySource for Encryption | Encryption_KeySource Optional |
| keyVaultProperties | Properties of KeyVault | KeyVaultProperties[] Optional |
| requireInfrastructureEncryption | Enable Infrastructure Encryption (Double Encryption) | bool Optional |
Encryption_STATUS
Properties to configure Encryption
Used by: Namespace_STATUS.
| Property | Description | Type |
|---|---|---|
| keySource | Enumerates the possible value of keySource for Encryption | Encryption_KeySource_STATUS Optional |
| keyVaultProperties | Properties of KeyVault | KeyVaultProperties_STATUS[] Optional |
| requireInfrastructureEncryption | Enable Infrastructure Encryption (Double Encryption) | bool Optional |
EntityStatus_STATUS
Entity status.
Used by: NamespacesQueue_STATUS, NamespacesTopic_STATUS, and NamespacesTopicsSubscription_STATUS.
| Value | Description |
|---|---|
| “Active” | |
| “Creating” | |
| “Deleting” | |
| “Disabled” | |
| “ReceiveDisabled” | |
| “Renaming” | |
| “Restoring” | |
| “SendDisabled” | |
| “Unknown” |
FilterType
Rule filter types
Used by: NamespacesTopicsSubscriptionsRule_Spec.
| Value | Description |
|---|---|
| “CorrelationFilter” | |
| “SqlFilter” |
FilterType_STATUS
Rule filter types
Used by: NamespacesTopicsSubscriptionsRule_STATUS.
| Value | Description |
|---|---|
| “CorrelationFilter” | |
| “SqlFilter” |
Identity
Properties to configure User Assigned Identities for Bring your Own Keys
Used by: Namespace_Spec.
| Property | Description | Type |
|---|---|---|
| type | Type of managed service identity. | Identity_Type Optional |
| userAssignedIdentities | Properties for User Assigned Identities | UserAssignedIdentityDetails[] Optional |
Identity_STATUS
Properties to configure User Assigned Identities for Bring your Own Keys
Used by: Namespace_STATUS.
| Property | Description | Type |
|---|---|---|
| principalId | ObjectId from the KeyVault | string Optional |
| tenantId | TenantId from the KeyVault | string Optional |
| type | Type of managed service identity. | Identity_Type_STATUS Optional |
| userAssignedIdentities | Properties for User Assigned Identities | map[string]UserAssignedIdentity_STATUS Optional |
MessageCountDetails_STATUS
Message Count Details.
Used by: NamespacesQueue_STATUS, NamespacesTopic_STATUS, and NamespacesTopicsSubscription_STATUS.
| Property | Description | Type |
|---|---|---|
| activeMessageCount | Number of active messages in the queue, topic, or subscription. | int Optional |
| deadLetterMessageCount | Number of messages that are dead lettered. | int Optional |
| scheduledMessageCount | Number of scheduled messages. | int Optional |
| transferDeadLetterMessageCount | Number of messages transferred into dead letters. | int Optional |
| transferMessageCount | Number of messages transferred to another queue, topic, or subscription. | int Optional |
NamespaceOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: Namespace_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
| secrets | configures where to place Azure generated secrets. | NamespaceOperatorSecrets Optional |
Namespaces_AuthorizationRule_Properties_Rights_Spec
Used by: NamespacesAuthorizationRule_Spec.
| Value | Description |
|---|---|
| “Listen” | |
| “Manage” | |
| “Send” |
Namespaces_AuthorizationRule_Properties_Rights_STATUS
Used by: NamespacesAuthorizationRule_STATUS.
| Value | Description |
|---|---|
| “Listen” | |
| “Manage” | |
| “Send” |
NamespacesAuthorizationRuleOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: NamespacesAuthorizationRule_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
| secrets | configures where to place Azure generated secrets. | NamespacesAuthorizationRuleOperatorSecrets Optional |
NamespacesQueueOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: NamespacesQueue_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
NamespacesTopicOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: NamespacesTopic_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
NamespacesTopicsSubscriptionOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: NamespacesTopicsSubscription_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
NamespacesTopicsSubscriptionsRuleOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: NamespacesTopicsSubscriptionsRule_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
PrivateEndpointConnection_STATUS
Properties of the PrivateEndpointConnection.
Used by: Namespace_STATUS.
| Property | Description | Type |
|---|---|---|
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
SBClientAffineProperties
Properties specific to client affine subscriptions.
Used by: NamespacesTopicsSubscription_Spec.
| Property | Description | Type |
|---|---|---|
| clientId | Indicates the Client ID of the application that created the client-affine subscription. | string Optional |
| isDurable | For client-affine subscriptions, this value indicates whether the subscription is durable or not. | bool Optional |
| isShared | For client-affine subscriptions, this value indicates whether the subscription is shared or not. | bool Optional |
SBClientAffineProperties_STATUS
Properties specific to client affine subscriptions.
Used by: NamespacesTopicsSubscription_STATUS.
| Property | Description | Type |
|---|---|---|
| clientId | Indicates the Client ID of the application that created the client-affine subscription. | string Optional |
| isDurable | For client-affine subscriptions, this value indicates whether the subscription is durable or not. | bool Optional |
| isShared | For client-affine subscriptions, this value indicates whether the subscription is shared or not. | bool Optional |
SBSku
SKU of the namespace.
Used by: Namespace_Spec.
| Property | Description | Type |
|---|---|---|
| capacity | The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4. | int Optional |
| name | Name of this SKU. | SBSku_Name Required |
| tier | The billing tier of this particular SKU. | SBSku_Tier Optional |
SBSku_STATUS
SKU of the namespace.
Used by: Namespace_STATUS.
| Property | Description | Type |
|---|---|---|
| capacity | The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4. | int Optional |
| name | Name of this SKU. | SBSku_Name_STATUS Optional |
| tier | The billing tier of this particular SKU. | SBSku_Tier_STATUS Optional |
SqlFilter
Represents a filter which is a composition of an expression and an action that is executed in the pub/sub pipeline.
Used by: NamespacesTopicsSubscriptionsRule_Spec.
| Property | Description | Type |
|---|---|---|
| compatibilityLevel | This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20. | int Optional |
| requiresPreprocessing | Value that indicates whether the rule action requires preprocessing. | bool Optional |
| sqlExpression | The SQL expression. e.g. MyProperty=‘ABC’ | string Optional |
SqlFilter_STATUS
Represents a filter which is a composition of an expression and an action that is executed in the pub/sub pipeline.
Used by: NamespacesTopicsSubscriptionsRule_STATUS.
| Property | Description | Type |
|---|---|---|
| compatibilityLevel | This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20. | int Optional |
| requiresPreprocessing | Value that indicates whether the rule action requires preprocessing. | bool Optional |
| sqlExpression | The SQL expression. e.g. MyProperty=‘ABC’ | string Optional |
SystemData_STATUS
Metadata pertaining to creation and last modification of the resource.
Used by: Namespace_STATUS, NamespacesAuthorizationRule_STATUS, NamespacesQueue_STATUS, NamespacesTopic_STATUS, NamespacesTopicsSubscription_STATUS, and NamespacesTopicsSubscriptionsRule_STATUS.
| Property | Description | Type |
|---|---|---|
| createdAt | The timestamp of resource creation (UTC). | string Optional |
| createdBy | The identity that created the resource. | string Optional |
| createdByType | The type of identity that created the resource. | SystemData_CreatedByType_STATUS Optional |
| lastModifiedAt | The type of identity that last modified the resource. | string Optional |
| lastModifiedBy | The identity that last modified the resource. | string Optional |
| lastModifiedByType | The type of identity that last modified the resource. | SystemData_LastModifiedByType_STATUS Optional |
Encryption_KeySource
Used by: Encryption.
| Value | Description |
|---|---|
| “Microsoft.KeyVault” |
Encryption_KeySource_STATUS
Used by: Encryption_STATUS.
| Value | Description |
|---|---|
| “Microsoft.KeyVault” |
Identity_Type
Used by: Identity.
| Value | Description |
|---|---|
| “None” | |
| “SystemAssigned” | |
| “SystemAssigned, UserAssigned” | |
| “UserAssigned” |
Identity_Type_STATUS
Used by: Identity_STATUS.
| Value | Description |
|---|---|
| “None” | |
| “SystemAssigned” | |
| “SystemAssigned, UserAssigned” | |
| “UserAssigned” |
KeyVaultProperties
Properties to configure keyVault Properties
Used by: Encryption.
| Property | Description | Type |
|---|---|---|
| identity | UserAssignedIdentityProperties Optional |
|
| keyName | Name of the Key from KeyVault | string Optional |
| keyVaultUri | Uri of KeyVault | string Optional |
| keyVersion | Version of KeyVault | string Optional |
KeyVaultProperties_STATUS
Properties to configure keyVault Properties
Used by: Encryption_STATUS.
| Property | Description | Type |
|---|---|---|
| identity | UserAssignedIdentityProperties_STATUS Optional |
|
| keyName | Name of the Key from KeyVault | string Optional |
| keyVaultUri | Uri of KeyVault | string Optional |
| keyVersion | Version of KeyVault | string Optional |
NamespaceOperatorSecrets
Used by: NamespaceOperatorSpec.
| Property | Description | Type |
|---|---|---|
| endpoint | indicates where the Endpoint secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
| primaryConnectionString | indicates where the PrimaryConnectionString secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
| primaryKey | indicates where the PrimaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
| secondaryConnectionString | indicates where the SecondaryConnectionString secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
| secondaryKey | indicates where the SecondaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
NamespacesAuthorizationRuleOperatorSecrets
Used by: NamespacesAuthorizationRuleOperatorSpec.
| Property | Description | Type |
|---|---|---|
| primaryConnectionString | indicates where the PrimaryConnectionString secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
| primaryKey | indicates where the PrimaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
| secondaryConnectionString | indicates where the SecondaryConnectionString secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
| secondaryKey | indicates where the SecondaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
SBSku_Name
Used by: SBSku.
| Value | Description |
|---|---|
| “Basic” | |
| “Premium” | |
| “Standard” |
SBSku_Name_STATUS
Used by: SBSku_STATUS.
| Value | Description |
|---|---|
| “Basic” | |
| “Premium” | |
| “Standard” |
SBSku_Tier
Used by: SBSku.
| Value | Description |
|---|---|
| “Basic” | |
| “Premium” | |
| “Standard” |
SBSku_Tier_STATUS
Used by: SBSku_STATUS.
| Value | Description |
|---|---|
| “Basic” | |
| “Premium” | |
| “Standard” |
SystemData_CreatedByType_STATUS
Used by: SystemData_STATUS.
| Value | Description |
|---|---|
| “Application” | |
| “Key” | |
| “ManagedIdentity” | |
| “User” |
SystemData_LastModifiedByType_STATUS
Used by: SystemData_STATUS.
| Value | Description |
|---|---|
| “Application” | |
| “Key” | |
| “ManagedIdentity” | |
| “User” |
UserAssignedIdentity_STATUS
Recognized Dictionary value.
Used by: Identity_STATUS.
| Property | Description | Type |
|---|---|---|
| clientId | Client Id of user assigned identity | string Optional |
| principalId | Principal Id of user assigned identity | string Optional |
UserAssignedIdentityDetails
Information about the user assigned identity for the resource
Used by: Identity.
| Property | Description | Type |
|---|---|---|
| reference | genruntime.ResourceReference Optional |
UserAssignedIdentityProperties
Used by: KeyVaultProperties.
| Property | Description | Type |
|---|---|---|
| userAssignedIdentityReference | ARM ID of user Identity selected for encryption | genruntime.ResourceReference Optional |
UserAssignedIdentityProperties_STATUS
Used by: KeyVaultProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| userAssignedIdentity | ARM ID of user Identity selected for encryption | string Optional |