servicebus.azure.com/v1api20210101preview

servicebus.azure.com/v1api20210101preview

Package v1api20210101preview contains API Schema definitions for the servicebus v1api20210101preview API group

Resource Types:

    APIVersion (string alias)

    Value Description

    "2021-01-01-preview"

    Action

    (Appears on:Namespaces_Topics_Subscriptions_Rule_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_ARM

    (Appears on:Ruleproperties_ARM)

    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:Namespaces_Topics_Subscriptions_Rule_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’

    Action_STATUS_ARM

    (Appears on:Ruleproperties_STATUS_ARM)

    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:Namespaces_Topics_Subscriptions_Rule_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_ARM

    (Appears on:Ruleproperties_ARM)

    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:Namespaces_Topics_Subscriptions_Rule_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.

    CorrelationFilter_STATUS_ARM

    (Appears on:Ruleproperties_STATUS_ARM)

    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.

    DictionaryValue_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

    DictionaryValue_STATUS_ARM

    (Appears on:Identity_STATUS_ARM)

    Recognized Dictionary value.

    Field Description
    clientId
    string

    ClientId: Client Id of user assigned identity

    principalId
    string

    PrincipalId: Principal Id of user assigned identity

    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_ARM

    (Appears on:SBNamespaceProperties_ARM)

    Properties to configure Encryption

    Field Description
    keySource
    Encryption_KeySource_ARM

    KeySource: Enumerates the possible value of keySource for Encryption

    keyVaultProperties
    []KeyVaultProperties_ARM

    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_ARM (string alias)

    (Appears on:Encryption_ARM)

    Value Description

    "Microsoft.KeyVault"

    Encryption_KeySource_STATUS (string alias)

    (Appears on:Encryption_STATUS)

    Value Description

    "Microsoft.KeyVault"

    Encryption_KeySource_STATUS_ARM (string alias)

    (Appears on:Encryption_STATUS_ARM)

    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)

    Encryption_STATUS_ARM

    (Appears on:SBNamespaceProperties_STATUS_ARM)

    Properties to configure Encryption

    Field Description
    keySource
    Encryption_KeySource_STATUS_ARM

    KeySource: Enumerates the possible value of keySource for Encryption

    keyVaultProperties
    []KeyVaultProperties_STATUS_ARM

    KeyVaultProperties: Properties of KeyVault

    requireInfrastructureEncryption
    bool

    RequireInfrastructureEncryption: Enable Infrastructure Encryption (Double Encryption)

    EntityStatus_STATUS (string alias)

    (Appears on:Namespaces_Queue_STATUS, Namespaces_Topic_STATUS, Namespaces_Topics_Subscription_STATUS)

    Entity status.

    Value Description

    "Active"

    "Creating"

    "Deleting"

    "Disabled"

    "ReceiveDisabled"

    "Renaming"

    "Restoring"

    "SendDisabled"

    "Unknown"

    EntityStatus_STATUS_ARM (string alias)

    (Appears on:SBQueueProperties_STATUS_ARM, SBSubscriptionProperties_STATUS_ARM, SBTopicProperties_STATUS_ARM)

    Entity status.

    Value Description

    "Active"

    "Creating"

    "Deleting"

    "Disabled"

    "ReceiveDisabled"

    "Renaming"

    "Restoring"

    "SendDisabled"

    "Unknown"

    FilterType (string alias)

    (Appears on:Namespaces_Topics_Subscriptions_Rule_Spec)

    Rule filter types

    Value Description

    "CorrelationFilter"

    "SqlFilter"

    FilterType_ARM (string alias)

    (Appears on:Ruleproperties_ARM)

    Rule filter types

    Value Description

    "CorrelationFilter"

    "SqlFilter"

    FilterType_STATUS (string alias)

    (Appears on:Namespaces_Topics_Subscriptions_Rule_STATUS)

    Rule filter types

    Value Description

    "CorrelationFilter"

    "SqlFilter"

    FilterType_STATUS_ARM (string alias)

    (Appears on:Ruleproperties_STATUS_ARM)

    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_ARM

    (Appears on:Namespace_Spec_ARM)

    Properties to configure User Assigned Identities for Bring your Own Keys

    Field Description
    type
    Identity_Type_ARM

    Type: Type of managed service identity.

    userAssignedIdentities
    map[string]./api/servicebus/v1api20210101preview.UserAssignedIdentityDetails_ARM

    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/v1api20210101preview.DictionaryValue_STATUS

    UserAssignedIdentities: Properties for User Assigned Identities

    Identity_STATUS_ARM

    (Appears on:Namespace_STATUS_ARM)

    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_ARM

    Type: Type of managed service identity.

    userAssignedIdentities
    map[string]./api/servicebus/v1api20210101preview.DictionaryValue_STATUS_ARM

    UserAssignedIdentities: Properties for User Assigned Identities

    Identity_Type (string alias)

    (Appears on:Identity)

    Value Description

    "None"

    "SystemAssigned"

    "SystemAssigned, UserAssigned"

    "UserAssigned"

    Identity_Type_ARM (string alias)

    (Appears on:Identity_ARM)

    Value Description

    "None"

    "SystemAssigned"

    "SystemAssigned, UserAssigned"

    "UserAssigned"

    Identity_Type_STATUS (string alias)

    (Appears on:Identity_STATUS)

    Value Description

    "None"

    "SystemAssigned"

    "SystemAssigned, UserAssigned"

    "UserAssigned"

    Identity_Type_STATUS_ARM (string alias)

    (Appears on:Identity_STATUS_ARM)

    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_ARM

    (Appears on:Encryption_ARM)

    Properties to configure keyVault Properties

    Field Description
    identity
    UserAssignedIdentityProperties_ARM
    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

    KeyVaultProperties_STATUS_ARM

    (Appears on:Encryption_STATUS_ARM)

    Properties to configure keyVault Properties

    Field Description
    identity
    UserAssignedIdentityProperties_STATUS_ARM
    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:Namespaces_Queue_STATUS, Namespaces_Topic_STATUS, Namespaces_Topics_Subscription_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.

    MessageCountDetails_STATUS_ARM

    (Appears on:SBQueueProperties_STATUS_ARM, SBSubscriptionProperties_STATUS_ARM, SBTopicProperties_STATUS_ARM)

    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/preview/2021-01-01-preview/namespace-preview.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.ServiceBus/​namespaces/​{namespaceName}

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    Namespace_Spec


    azureName
    string

    AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.

    encryption
    Encryption

    Encryption: Properties 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.

    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
    secrets
    NamespaceOperatorSecrets

    Secrets: configures where to place Azure generated secrets.

    Namespace_STATUS

    (Appears on:Namespace)

    Field Description
    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    createdAt
    string

    CreatedAt: The time the namespace was created

    encryption
    Encryption_STATUS

    Encryption: Properties of BYOK Encryption description

    id
    string

    Id: Resource Id

    identity
    Identity_STATUS

    Identity: Properties of BYOK Identity description

    location
    string

    Location: The Geo-location where the resource lives

    metricId
    string

    MetricId: Identifier for Azure Insights metrics

    name
    string

    Name: Resource name

    privateEndpointConnections
    []PrivateEndpointConnection_STATUS

    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_STATUS_ARM

    Field Description
    id
    string

    Id: Resource Id

    identity
    Identity_STATUS_ARM

    Identity: Properties of BYOK Identity description

    location
    string

    Location: The Geo-location where the resource lives

    name
    string

    Name: Resource name

    properties
    SBNamespaceProperties_STATUS_ARM

    Properties: Properties of the namespace.

    sku
    SBSku_STATUS_ARM

    Sku: Properties of SKU

    systemData
    SystemData_STATUS_ARM

    SystemData: The system meta data relating to this resource.

    tags
    map[string]string

    Tags: Resource tags

    type
    string

    Type: Resource type

    Namespace_Spec

    (Appears on:Namespace)

    Field Description
    azureName
    string

    AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.

    encryption
    Encryption

    Encryption: Properties 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.

    Namespace_Spec_ARM

    Field Description
    identity
    Identity_ARM

    Identity: Properties of BYOK Identity description

    location
    string

    Location: The Geo-location where the resource lives

    name
    string
    properties
    SBNamespaceProperties_ARM

    Properties: Properties of the namespace.

    sku
    SBSku_ARM

    Sku: Properties of SKU

    tags
    map[string]string

    Tags: Resource tags

    NamespacesAuthorizationRule

    Generator information: - Generated from: /servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-01-01-preview/AuthorizationRules.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.ServiceBus/​namespaces/​{namespaceName}/​AuthorizationRules/​{authorizationRuleName}

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    Namespaces_AuthorizationRule_Spec


    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.

    status
    Namespaces_AuthorizationRule_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:Namespaces_AuthorizationRule_Spec)

    Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

    Field Description
    secrets
    NamespacesAuthorizationRuleOperatorSecrets

    Secrets: configures where to place Azure generated secrets.

    NamespacesQueue

    Generator information: - Generated from: /servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-01-01-preview/Queue.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.ServiceBus/​namespaces/​{namespaceName}/​queues/​{queueName}

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    Namespaces_Queue_Spec


    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.

    maxSizeInMegabytes
    int

    MaxSizeInMegabytes: The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024.

    owner
    genruntime.KnownResourceReference

    Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a servicebus.azure.com/Namespace resource

    requiresDuplicateDetection
    bool

    RequiresDuplicateDetection: A value indicating if this queue requires duplicate detection.

    requiresSession
    bool

    RequiresSession: A value that indicates whether the queue supports the concept of sessions.

    status
    Namespaces_Queue_STATUS

    NamespacesTopic

    Generator information: - Generated from: /servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-01-01-preview/topics.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.ServiceBus/​namespaces/​{namespaceName}/​topics/​{topicName}

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    Namespaces_Topic_Spec


    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.

    maxSizeInMegabytes
    int

    MaxSizeInMegabytes: Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024.

    owner
    genruntime.KnownResourceReference

    Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a servicebus.azure.com/Namespace resource

    requiresDuplicateDetection
    bool

    RequiresDuplicateDetection: Value indicating if this topic requires duplicate detection.

    supportOrdering
    bool

    SupportOrdering: Value that indicates whether the topic supports ordering.

    status
    Namespaces_Topic_STATUS

    NamespacesTopicsSubscription

    Generator information: - Generated from: /servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-01-01-preview/subscriptions.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.ServiceBus/​namespaces/​{namespaceName}/​topics/​{topicName}/​subscriptions/​{subscriptionName}

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    Namespaces_Topics_Subscription_Spec


    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.

    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

    lockDuration
    string

    LockDuration: ISO 8061 lock duration timespan for the subscription. The default value is 1 minute.

    maxDeliveryCount
    int

    MaxDeliveryCount: Number of maximum deliveries.

    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.

    status
    Namespaces_Topics_Subscription_STATUS

    NamespacesTopicsSubscriptionsRule

    Generator information: - Generated from: /servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-01-01-preview/Rules.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.ServiceBus/​namespaces/​{namespaceName}/​topics/​{topicName}/​subscriptions/​{subscriptionName}/​rules/​{ruleName}

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    Namespaces_Topics_Subscriptions_Rule_Spec


    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.

    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

    status
    Namespaces_Topics_Subscriptions_Rule_STATUS

    Namespaces_AuthorizationRule_Properties_Rights_STATUS (string alias)

    (Appears on:Namespaces_AuthorizationRule_STATUS)

    Value Description

    "Listen"

    "Manage"

    "Send"

    Namespaces_AuthorizationRule_Properties_Rights_STATUS_ARM (string alias)

    (Appears on:Namespaces_AuthorizationRule_Properties_STATUS_ARM)

    Value Description

    "Listen"

    "Manage"

    "Send"

    Namespaces_AuthorizationRule_Properties_Rights_Spec (string alias)

    (Appears on:Namespaces_AuthorizationRule_Spec)

    Value Description

    "Listen"

    "Manage"

    "Send"

    Namespaces_AuthorizationRule_Properties_Rights_Spec_ARM (string alias)

    (Appears on:Namespaces_AuthorizationRule_Properties_Spec_ARM)

    Value Description

    "Listen"

    "Manage"

    "Send"

    Namespaces_AuthorizationRule_Properties_STATUS_ARM

    (Appears on:Namespaces_AuthorizationRule_STATUS_ARM)

    Field Description
    rights
    []Namespaces_AuthorizationRule_Properties_Rights_STATUS_ARM

    Rights: The rights associated with the rule.

    Namespaces_AuthorizationRule_Properties_Spec_ARM

    (Appears on:Namespaces_AuthorizationRule_Spec_ARM)

    Field Description
    rights
    []Namespaces_AuthorizationRule_Properties_Rights_Spec_ARM

    Rights: The rights associated with the rule.

    Namespaces_AuthorizationRule_STATUS

    (Appears on:NamespacesAuthorizationRule)

    Field Description
    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    id
    string

    Id: Resource Id

    name
    string

    Name: Resource name

    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: Resource type

    Namespaces_AuthorizationRule_STATUS_ARM

    Field Description
    id
    string

    Id: Resource Id

    name
    string

    Name: Resource name

    properties
    Namespaces_AuthorizationRule_Properties_STATUS_ARM

    Properties: AuthorizationRule properties.

    systemData
    SystemData_STATUS_ARM

    SystemData: The system meta data relating to this resource.

    type
    string

    Type: Resource type

    Namespaces_AuthorizationRule_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.

    Namespaces_AuthorizationRule_Spec_ARM

    Field Description
    name
    string
    properties
    Namespaces_AuthorizationRule_Properties_Spec_ARM

    Properties: AuthorizationRule properties.

    Namespaces_Queue_STATUS

    (Appears on:NamespacesQueue)

    Field Description
    accessedAt
    string

    AccessedAt: Last time a message was sent, or the last time there was a receive request to this queue.

    autoDeleteOnIdle
    string

    AutoDeleteOnIdle: ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes.

    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    countDetails
    MessageCountDetails_STATUS

    CountDetails: Message Count Details.

    createdAt
    string

    CreatedAt: The exact time the message was created.

    deadLetteringOnMessageExpiration
    bool

    DeadLetteringOnMessageExpiration: A value that indicates whether this queue has dead letter support when a message expires.

    defaultMessageTimeToLive
    string

    DefaultMessageTimeToLive: ISO 8601 default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.

    duplicateDetectionHistoryTimeWindow
    string

    DuplicateDetectionHistoryTimeWindow: ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.

    enableBatchedOperations
    bool

    EnableBatchedOperations: Value that indicates whether server-side batched operations are enabled.

    enableExpress
    bool

    EnableExpress: A value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage.

    enablePartitioning
    bool

    EnablePartitioning: A value that indicates whether the queue is to be partitioned across multiple message brokers.

    forwardDeadLetteredMessagesTo
    string

    ForwardDeadLetteredMessagesTo: Queue/Topic name to forward the Dead Letter message

    forwardTo
    string

    ForwardTo: Queue/Topic name to forward the messages

    id
    string

    Id: Resource Id

    lockDuration
    string

    LockDuration: ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute.

    maxDeliveryCount
    int

    MaxDeliveryCount: The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10.

    maxSizeInMegabytes
    int

    MaxSizeInMegabytes: The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024.

    messageCount
    int

    MessageCount: The number of messages in the queue.

    name
    string

    Name: Resource name

    requiresDuplicateDetection
    bool

    RequiresDuplicateDetection: A value indicating if this queue requires duplicate detection.

    requiresSession
    bool

    RequiresSession: A value that indicates whether the queue supports the concept of sessions.

    sizeInBytes
    int

    SizeInBytes: The size of the queue, in bytes.

    status
    EntityStatus_STATUS

    Status: Enumerates the possible values for the status of a messaging entity.

    systemData
    SystemData_STATUS

    SystemData: The system meta data relating to this resource.

    type
    string

    Type: Resource type

    updatedAt
    string

    UpdatedAt: The exact time the message was updated.

    Namespaces_Queue_STATUS_ARM

    Field Description
    id
    string

    Id: Resource Id

    name
    string

    Name: Resource name

    properties
    SBQueueProperties_STATUS_ARM

    Properties: Queue Properties

    systemData
    SystemData_STATUS_ARM

    SystemData: The system meta data relating to this resource.

    type
    string

    Type: Resource type

    Namespaces_Queue_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.

    maxSizeInMegabytes
    int

    MaxSizeInMegabytes: The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024.

    owner
    genruntime.KnownResourceReference

    Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a servicebus.azure.com/Namespace resource

    requiresDuplicateDetection
    bool

    RequiresDuplicateDetection: A value indicating if this queue requires duplicate detection.

    requiresSession
    bool

    RequiresSession: A value that indicates whether the queue supports the concept of sessions.

    Namespaces_Queue_Spec_ARM

    Field Description
    name
    string
    properties
    SBQueueProperties_ARM

    Properties: Queue Properties

    Namespaces_Topic_STATUS

    (Appears on:NamespacesTopic)

    Field Description
    accessedAt
    string

    AccessedAt: Last time the message was sent, or a request was received, for this topic.

    autoDeleteOnIdle
    string

    AutoDeleteOnIdle: ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.

    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    countDetails
    MessageCountDetails_STATUS

    CountDetails: Message count details

    createdAt
    string

    CreatedAt: Exact time the message was created.

    defaultMessageTimeToLive
    string

    DefaultMessageTimeToLive: ISO 8601 Default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.

    duplicateDetectionHistoryTimeWindow
    string

    DuplicateDetectionHistoryTimeWindow: ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.

    enableBatchedOperations
    bool

    EnableBatchedOperations: Value that indicates whether server-side batched operations are enabled.

    enableExpress
    bool

    EnableExpress: Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage.

    enablePartitioning
    bool

    EnablePartitioning: Value that indicates whether the topic to be partitioned across multiple message brokers is enabled.

    id
    string

    Id: Resource Id

    maxSizeInMegabytes
    int

    MaxSizeInMegabytes: Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024.

    name
    string

    Name: Resource name

    requiresDuplicateDetection
    bool

    RequiresDuplicateDetection: Value indicating if this topic requires duplicate detection.

    sizeInBytes
    int

    SizeInBytes: Size of the topic, in bytes.

    status
    EntityStatus_STATUS

    Status: Enumerates the possible values for the status of a messaging entity.

    subscriptionCount
    int

    SubscriptionCount: Number of subscriptions.

    supportOrdering
    bool

    SupportOrdering: Value that indicates whether the topic supports ordering.

    systemData
    SystemData_STATUS

    SystemData: The system meta data relating to this resource.

    type
    string

    Type: Resource type

    updatedAt
    string

    UpdatedAt: The exact time the message was updated.

    Namespaces_Topic_STATUS_ARM

    Field Description
    id
    string

    Id: Resource Id

    name
    string

    Name: Resource name

    properties
    SBTopicProperties_STATUS_ARM

    Properties: Properties of topic resource.

    systemData
    SystemData_STATUS_ARM

    SystemData: The system meta data relating to this resource.

    type
    string

    Type: Resource type

    Namespaces_Topic_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.

    maxSizeInMegabytes
    int

    MaxSizeInMegabytes: Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024.

    owner
    genruntime.KnownResourceReference

    Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a servicebus.azure.com/Namespace resource

    requiresDuplicateDetection
    bool

    RequiresDuplicateDetection: Value indicating if this topic requires duplicate detection.

    supportOrdering
    bool

    SupportOrdering: Value that indicates whether the topic supports ordering.

    Namespaces_Topic_Spec_ARM

    Field Description
    name
    string
    properties
    SBTopicProperties_ARM

    Properties: Properties of topic resource.

    Namespaces_Topics_Subscription_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.

    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: Resource 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.

    messageCount
    int

    MessageCount: Number of messages.

    name
    string

    Name: Resource name

    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: Resource type

    updatedAt
    string

    UpdatedAt: The exact time the message was updated.

    Namespaces_Topics_Subscription_STATUS_ARM

    Field Description
    id
    string

    Id: Resource Id

    name
    string

    Name: Resource name

    properties
    SBSubscriptionProperties_STATUS_ARM

    Properties: Properties of subscriptions resource.

    systemData
    SystemData_STATUS_ARM

    SystemData: The system meta data relating to this resource.

    type
    string

    Type: Resource type

    Namespaces_Topics_Subscription_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.

    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

    lockDuration
    string

    LockDuration: ISO 8061 lock duration timespan for the subscription. The default value is 1 minute.

    maxDeliveryCount
    int

    MaxDeliveryCount: Number of maximum deliveries.

    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.

    Namespaces_Topics_Subscription_Spec_ARM

    Field Description
    name
    string
    properties
    SBSubscriptionProperties_ARM

    Properties: Properties of subscriptions resource.

    Namespaces_Topics_Subscriptions_Rule_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: Resource Id

    name
    string

    Name: Resource name

    sqlFilter
    SqlFilter_STATUS

    SqlFilter: Properties of sqlFilter

    systemData
    SystemData_STATUS

    SystemData: The system meta data relating to this resource.

    type
    string

    Type: Resource type

    Namespaces_Topics_Subscriptions_Rule_STATUS_ARM

    Field Description
    id
    string

    Id: Resource Id

    name
    string

    Name: Resource name

    properties
    Ruleproperties_STATUS_ARM

    Properties: Properties of Rule resource

    systemData
    SystemData_STATUS_ARM

    SystemData: The system meta data relating to this resource.

    type
    string

    Type: Resource type

    Namespaces_Topics_Subscriptions_Rule_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.

    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_Topics_Subscriptions_Rule_Spec_ARM

    Field Description
    name
    string
    properties
    Ruleproperties_ARM

    Properties: Properties of Rule resource

    PrivateEndpointConnection_STATUS

    (Appears on:Namespace_STATUS)

    Properties of the PrivateEndpointConnection.

    Field Description
    id
    string

    Id: Resource Id

    PrivateEndpointConnection_STATUS_ARM

    (Appears on:SBNamespaceProperties_STATUS_ARM)

    Properties of the PrivateEndpointConnection.

    Field Description
    id
    string

    Id: Resource Id

    Ruleproperties_ARM

    (Appears on:Namespaces_Topics_Subscriptions_Rule_Spec_ARM)

    Description of Rule Resource.

    Field Description
    action
    Action_ARM

    Action: Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression.

    correlationFilter
    CorrelationFilter_ARM

    CorrelationFilter: Properties of correlationFilter

    filterType
    FilterType_ARM

    FilterType: Filter type that is evaluated against a BrokeredMessage.

    sqlFilter
    SqlFilter_ARM

    SqlFilter: Properties of sqlFilter

    Ruleproperties_STATUS_ARM

    (Appears on:Namespaces_Topics_Subscriptions_Rule_STATUS_ARM)

    Description of Rule Resource.

    Field Description
    action
    Action_STATUS_ARM

    Action: Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression.

    correlationFilter
    CorrelationFilter_STATUS_ARM

    CorrelationFilter: Properties of correlationFilter

    filterType
    FilterType_STATUS_ARM

    FilterType: Filter type that is evaluated against a BrokeredMessage.

    sqlFilter
    SqlFilter_STATUS_ARM

    SqlFilter: Properties of sqlFilter

    SBNamespaceProperties_ARM

    (Appears on:Namespace_Spec_ARM)

    Properties of the namespace.

    Field Description
    encryption
    Encryption_ARM

    Encryption: Properties of BYOK Encryption description

    zoneRedundant
    bool

    ZoneRedundant: Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones.

    SBNamespaceProperties_STATUS_ARM

    (Appears on:Namespace_STATUS_ARM)

    Properties of the namespace.

    Field Description
    createdAt
    string

    CreatedAt: The time the namespace was created

    encryption
    Encryption_STATUS_ARM

    Encryption: Properties of BYOK Encryption description

    metricId
    string

    MetricId: Identifier for Azure Insights metrics

    privateEndpointConnections
    []PrivateEndpointConnection_STATUS_ARM

    PrivateEndpointConnections: List of private endpoint connections.

    provisioningState
    string

    ProvisioningState: Provisioning state of the namespace.

    serviceBusEndpoint
    string

    ServiceBusEndpoint: Endpoint you can use to perform Service Bus operations.

    status
    string

    Status: Status of the namespace.

    updatedAt
    string

    UpdatedAt: The time the namespace was updated.

    zoneRedundant
    bool

    ZoneRedundant: Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones.

    SBQueueProperties_ARM

    (Appears on:Namespaces_Queue_Spec_ARM)

    The Queue Properties definition.

    Field Description
    autoDeleteOnIdle
    string

    AutoDeleteOnIdle: ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes.

    deadLetteringOnMessageExpiration
    bool

    DeadLetteringOnMessageExpiration: A value that indicates whether this queue has dead letter support when a message expires.

    defaultMessageTimeToLive
    string

    DefaultMessageTimeToLive: ISO 8601 default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.

    duplicateDetectionHistoryTimeWindow
    string

    DuplicateDetectionHistoryTimeWindow: ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.

    enableBatchedOperations
    bool

    EnableBatchedOperations: Value that indicates whether server-side batched operations are enabled.

    enableExpress
    bool

    EnableExpress: A value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage.

    enablePartitioning
    bool

    EnablePartitioning: A value that indicates whether the queue is to be partitioned across multiple message brokers.

    forwardDeadLetteredMessagesTo
    string

    ForwardDeadLetteredMessagesTo: Queue/Topic name to forward the Dead Letter message

    forwardTo
    string

    ForwardTo: Queue/Topic name to forward the messages

    lockDuration
    string

    LockDuration: ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute.

    maxDeliveryCount
    int

    MaxDeliveryCount: The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10.

    maxSizeInMegabytes
    int

    MaxSizeInMegabytes: The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024.

    requiresDuplicateDetection
    bool

    RequiresDuplicateDetection: A value indicating if this queue requires duplicate detection.

    requiresSession
    bool

    RequiresSession: A value that indicates whether the queue supports the concept of sessions.

    SBQueueProperties_STATUS_ARM

    (Appears on:Namespaces_Queue_STATUS_ARM)

    The Queue Properties definition.

    Field Description
    accessedAt
    string

    AccessedAt: Last time a message was sent, or the last time there was a receive request to this queue.

    autoDeleteOnIdle
    string

    AutoDeleteOnIdle: ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes.

    countDetails
    MessageCountDetails_STATUS_ARM

    CountDetails: Message Count Details.

    createdAt
    string

    CreatedAt: The exact time the message was created.

    deadLetteringOnMessageExpiration
    bool

    DeadLetteringOnMessageExpiration: A value that indicates whether this queue has dead letter support when a message expires.

    defaultMessageTimeToLive
    string

    DefaultMessageTimeToLive: ISO 8601 default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.

    duplicateDetectionHistoryTimeWindow
    string

    DuplicateDetectionHistoryTimeWindow: ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.

    enableBatchedOperations
    bool

    EnableBatchedOperations: Value that indicates whether server-side batched operations are enabled.

    enableExpress
    bool

    EnableExpress: A value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage.

    enablePartitioning
    bool

    EnablePartitioning: A value that indicates whether the queue is to be partitioned across multiple message brokers.

    forwardDeadLetteredMessagesTo
    string

    ForwardDeadLetteredMessagesTo: Queue/Topic name to forward the Dead Letter message

    forwardTo
    string

    ForwardTo: Queue/Topic name to forward the messages

    lockDuration
    string

    LockDuration: ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute.

    maxDeliveryCount
    int

    MaxDeliveryCount: The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10.

    maxSizeInMegabytes
    int

    MaxSizeInMegabytes: The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024.

    messageCount
    int

    MessageCount: The number of messages in the queue.

    requiresDuplicateDetection
    bool

    RequiresDuplicateDetection: A value indicating if this queue requires duplicate detection.

    requiresSession
    bool

    RequiresSession: A value that indicates whether the queue supports the concept of sessions.

    sizeInBytes
    int

    SizeInBytes: The size of the queue, in bytes.

    status
    EntityStatus_STATUS_ARM

    Status: Enumerates the possible values for the status of a messaging entity.

    updatedAt
    string

    UpdatedAt: The exact time the message was updated.

    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_ARM

    (Appears on:Namespace_Spec_ARM)

    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_ARM

    Name: Name of this SKU.

    tier
    SBSku_Tier_ARM

    Tier: The billing tier of this particular SKU.

    SBSku_Name (string alias)

    (Appears on:SBSku)

    Value Description

    "Basic"

    "Premium"

    "Standard"

    SBSku_Name_ARM (string alias)

    (Appears on:SBSku_ARM)

    Value Description

    "Basic"

    "Premium"

    "Standard"

    SBSku_Name_STATUS (string alias)

    (Appears on:SBSku_STATUS)

    Value Description

    "Basic"

    "Premium"

    "Standard"

    SBSku_Name_STATUS_ARM (string alias)

    (Appears on:SBSku_STATUS_ARM)

    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_STATUS_ARM

    (Appears on:Namespace_STATUS_ARM)

    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_ARM

    Name: Name of this SKU.

    tier
    SBSku_Tier_STATUS_ARM

    Tier: The billing tier of this particular SKU.

    SBSku_Tier (string alias)

    (Appears on:SBSku)

    Value Description

    "Basic"

    "Premium"

    "Standard"

    SBSku_Tier_ARM (string alias)

    (Appears on:SBSku_ARM)

    Value Description

    "Basic"

    "Premium"

    "Standard"

    SBSku_Tier_STATUS (string alias)

    (Appears on:SBSku_STATUS)

    Value Description

    "Basic"

    "Premium"

    "Standard"

    SBSku_Tier_STATUS_ARM (string alias)

    (Appears on:SBSku_STATUS_ARM)

    Value Description

    "Basic"

    "Premium"

    "Standard"

    SBSubscriptionProperties_ARM

    (Appears on:Namespaces_Topics_Subscription_Spec_ARM)

    Description of Subscription Resource.

    Field Description
    autoDeleteOnIdle
    string

    AutoDeleteOnIdle: ISO 8061 timeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.

    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

    lockDuration
    string

    LockDuration: ISO 8061 lock duration timespan for the subscription. The default value is 1 minute.

    maxDeliveryCount
    int

    MaxDeliveryCount: Number of maximum deliveries.

    requiresSession
    bool

    RequiresSession: Value indicating if a subscription supports the concept of sessions.

    SBSubscriptionProperties_STATUS_ARM

    (Appears on:Namespaces_Topics_Subscription_STATUS_ARM)

    Description of Subscription Resource.

    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.

    countDetails
    MessageCountDetails_STATUS_ARM

    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

    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.

    requiresSession
    bool

    RequiresSession: Value indicating if a subscription supports the concept of sessions.

    status
    EntityStatus_STATUS_ARM

    Status: Enumerates the possible values for the status of a messaging entity.

    updatedAt
    string

    UpdatedAt: The exact time the message was updated.

    SBTopicProperties_ARM

    (Appears on:Namespaces_Topic_Spec_ARM)

    The Topic Properties definition.

    Field Description
    autoDeleteOnIdle
    string

    AutoDeleteOnIdle: ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.

    defaultMessageTimeToLive
    string

    DefaultMessageTimeToLive: ISO 8601 Default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.

    duplicateDetectionHistoryTimeWindow
    string

    DuplicateDetectionHistoryTimeWindow: ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.

    enableBatchedOperations
    bool

    EnableBatchedOperations: Value that indicates whether server-side batched operations are enabled.

    enableExpress
    bool

    EnableExpress: Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage.

    enablePartitioning
    bool

    EnablePartitioning: Value that indicates whether the topic to be partitioned across multiple message brokers is enabled.

    maxSizeInMegabytes
    int

    MaxSizeInMegabytes: Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024.

    requiresDuplicateDetection
    bool

    RequiresDuplicateDetection: Value indicating if this topic requires duplicate detection.

    supportOrdering
    bool

    SupportOrdering: Value that indicates whether the topic supports ordering.

    SBTopicProperties_STATUS_ARM

    (Appears on:Namespaces_Topic_STATUS_ARM)

    The Topic Properties definition.

    Field Description
    accessedAt
    string

    AccessedAt: Last time the message was sent, or a request was received, for this topic.

    autoDeleteOnIdle
    string

    AutoDeleteOnIdle: ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.

    countDetails
    MessageCountDetails_STATUS_ARM

    CountDetails: Message count details

    createdAt
    string

    CreatedAt: Exact time the message was created.

    defaultMessageTimeToLive
    string

    DefaultMessageTimeToLive: ISO 8601 Default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.

    duplicateDetectionHistoryTimeWindow
    string

    DuplicateDetectionHistoryTimeWindow: ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.

    enableBatchedOperations
    bool

    EnableBatchedOperations: Value that indicates whether server-side batched operations are enabled.

    enableExpress
    bool

    EnableExpress: Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage.

    enablePartitioning
    bool

    EnablePartitioning: Value that indicates whether the topic to be partitioned across multiple message brokers is enabled.

    maxSizeInMegabytes
    int

    MaxSizeInMegabytes: Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024.

    requiresDuplicateDetection
    bool

    RequiresDuplicateDetection: Value indicating if this topic requires duplicate detection.

    sizeInBytes
    int

    SizeInBytes: Size of the topic, in bytes.

    status
    EntityStatus_STATUS_ARM

    Status: Enumerates the possible values for the status of a messaging entity.

    subscriptionCount
    int

    SubscriptionCount: Number of subscriptions.

    supportOrdering
    bool

    SupportOrdering: Value that indicates whether the topic supports ordering.

    updatedAt
    string

    UpdatedAt: The exact time the message was updated.

    SqlFilter

    (Appears on:Namespaces_Topics_Subscriptions_Rule_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_ARM

    (Appears on:Ruleproperties_ARM)

    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:Namespaces_Topics_Subscriptions_Rule_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’

    SqlFilter_STATUS_ARM

    (Appears on:Ruleproperties_STATUS_ARM)

    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_CreatedByType_STATUS_ARM (string alias)

    (Appears on:SystemData_STATUS_ARM)

    Value Description

    "Application"

    "Key"

    "ManagedIdentity"

    "User"

    SystemData_LastModifiedByType_STATUS (string alias)

    (Appears on:SystemData_STATUS)

    Value Description

    "Application"

    "Key"

    "ManagedIdentity"

    "User"

    SystemData_LastModifiedByType_STATUS_ARM (string alias)

    (Appears on:SystemData_STATUS_ARM)

    Value Description

    "Application"

    "Key"

    "ManagedIdentity"

    "User"

    SystemData_STATUS

    (Appears on:Namespace_STATUS, Namespaces_AuthorizationRule_STATUS, Namespaces_Queue_STATUS, Namespaces_Topic_STATUS, Namespaces_Topics_Subscription_STATUS, Namespaces_Topics_Subscriptions_Rule_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.

    SystemData_STATUS_ARM

    (Appears on:Namespace_STATUS_ARM, Namespaces_AuthorizationRule_STATUS_ARM, Namespaces_Queue_STATUS_ARM, Namespaces_Topic_STATUS_ARM, Namespaces_Topics_Subscription_STATUS_ARM, Namespaces_Topics_Subscriptions_Rule_STATUS_ARM)

    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_ARM

    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_ARM

    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

    UserAssignedIdentityDetails_ARM

    (Appears on:Identity_ARM)

    Information about the user assigned identity for the resource

    UserAssignedIdentityProperties

    (Appears on:KeyVaultProperties)

    Field Description
    userAssignedIdentityReference
    genruntime.ResourceReference

    UserAssignedIdentityReference: ARM ID of user Identity selected for encryption

    UserAssignedIdentityProperties_ARM

    (Appears on:KeyVaultProperties_ARM)

    Field Description
    userAssignedIdentity
    string

    UserAssignedIdentityProperties_STATUS

    (Appears on:KeyVaultProperties_STATUS)

    Field Description
    userAssignedIdentity
    string

    UserAssignedIdentity: ARM ID of user Identity selected for encryption

    UserAssignedIdentityProperties_STATUS_ARM

    (Appears on:KeyVaultProperties_STATUS_ARM)

    Field Description
    userAssignedIdentity
    string

    UserAssignedIdentity: ARM ID of user Identity selected for encryption