aspire/src/Components/Aspire.Azure.Messaging.ServiceBus/ConfigurationSchema.json at v9.1.0 · dotnet/aspire · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
{
  "definitions": {
    "logLevel": {
      "properties": {
        "Azure": {
          "$ref": "#/definitions/logLevelThreshold"
        },
        "Azure.Core": {
          "$ref": "#/definitions/logLevelThreshold"
        },
        "Azure.Identity": {
          "$ref": "#/definitions/logLevelThreshold"
        },
        "Azure.Messaging.ServiceBus": {
          "$ref": "#/definitions/logLevelThreshold"
        }
      }
    }
  },
  "type": "object",
  "properties": {
    "Aspire": {
      "type": "object",
      "properties": {
        "Azure": {
          "type": "object",
          "properties": {
            "Messaging": {
              "type": "object",
              "properties": {
                "ServiceBus": {
                  "type": "object",
                  "properties": {
                    "ClientOptions": {
                      "type": "object",
                      "properties": {
                        "ConnectionIdleTimeout": {
                          "type": "string",
                          "pattern": "^-?(\\d{1,7}|((\\d{1,7}[\\.:])?(([01]?\\d|2[0-3]):[0-5]?\\d|([01]?\\d|2[0-3]):[0-5]?\\d:[0-5]?\\d)(\\.\\d{1,7})?))$",
                          "description": "The amount of time to allow a connection to have no observed traffic before considering it idle and eligible to close."
                        },
                        "CustomEndpointAddress": {
                          "type": "string",
                          "format": "uri",
                          "description": "A custom endpoint address that can be used when establishing the connection to the Service Bus service."
                        },
                        "EnableCrossEntityTransactions": {
                          "type": "boolean",
                          "description": "Gets or sets a flag that indicates whether or not transactions may span multiple Service Bus entities."
                        },
                        "Identifier": {
                          "type": "string",
                          "description": "A property used to set the 'Azure.Messaging.ServiceBus.ServiceBusClient' ID to identify the client. This can be used to correlate logs and exceptions. If null or empty, a random unique value will be used."
                        },
                        "RetryOptions": {
                          "type": "object",
                          "properties": {
                            "Delay": {
                              "type": "string",
                              "pattern": "^-?(\\d{1,7}|((\\d{1,7}[\\.:])?(([01]?\\d|2[0-3]):[0-5]?\\d|([01]?\\d|2[0-3]):[0-5]?\\d:[0-5]?\\d)(\\.\\d{1,7})?))$",
                              "description": "The delay between retry attempts for a fixed approach or the delay on which to base calculations for a backoff-based approach."
                            },
                            "MaxDelay": {
                              "type": "string",
                              "pattern": "^-?(\\d{1,7}|((\\d{1,7}[\\.:])?(([01]?\\d|2[0-3]):[0-5]?\\d|([01]?\\d|2[0-3]):[0-5]?\\d:[0-5]?\\d)(\\.\\d{1,7})?))$",
                              "description": "The maximum permissible delay between retry attempts."
                            },
                            "MaxRetries": {
                              "type": "integer",
                              "description": "The maximum number of retry attempts before considering the associated operation to have failed."
                            },
                            "Mode": {
                              "enum": [
                                "Fixed",
                                "Exponential"
                              ],
                              "description": "The approach to use for calculating retry delays."
                            },
                            "TryTimeout": {
                              "type": "string",
                              "pattern": "^-?(\\d{1,7}|((\\d{1,7}[\\.:])?(([01]?\\d|2[0-3]):[0-5]?\\d|([01]?\\d|2[0-3]):[0-5]?\\d:[0-5]?\\d)(\\.\\d{1,7})?))$",
                              "description": "The maximum duration to wait for completion of a single attempt, whether the initial attempt or a retry."
                            }
                          },
                          "description": "The set of options to use for determining whether a failed service operation should be retried and, if so, the amount of time to wait between retry attempts.  These options also control the amount of time allowed for the individual network operations used for interactions with the Service Bus service."
                        },
                        "TransportType": {
                          "enum": [
                            "AmqpTcp",
                            "AmqpWebSockets"
                          ],
                          "description": "The type of protocol and transport that will be used for communicating with the Service Bus service."
                        }
                      },
                      "description": "The set of options that can be specified when creating an 'Azure.Messaging.ServiceBus.ServiceBusConnection' to configure its behavior."
                    },
                    "ConnectionString": {
                      "type": "string",
                      "description": "Gets or sets the connection string used to connect to the Service Bus namespace."
                    },
                    "DisableTracing": {
                      "type": "boolean",
                      "description": "Gets or sets a boolean value that indicates whether the OpenTelemetry tracing is disabled or not.",
                      "default": false
                    },
                    "FullyQualifiedNamespace": {
                      "type": "string",
                      "description": "Gets or sets the fully qualified Service Bus namespace."
                    },
                    "HealthCheckQueueName": {
                      "type": "string",
                      "description": "Name of the queue used by the health check. Mandatory to get health checks enabled."
                    },
                    "HealthCheckTopicName": {
                      "type": "string",
                      "description": "Name of the topic used by the health check. Mandatory to get health checks enabled."
                    }
                  },
                  "description": "Provides the client configuration settings for connecting to Azure Service Bus."
                }
              }
            }
          }
        }
      }
    }
  }
}