-
Notifications
You must be signed in to change notification settings - Fork 223
/
com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder.yml
263 lines (263 loc) · 50.4 KB
/
com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder.yml
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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
### YamlMime:JavaType
uid: "com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder"
fullName: "com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder"
name: "ServiceBusAdministrationClientBuilder"
nameWithType: "ServiceBusAdministrationClientBuilder"
summary: "This class provides a fluent builder API to help aid the configuration and instantiation of <xref uid=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceBusAdministrationClient\"></xref> and <xref uid=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceBusAdministrationAsyncClient\"></xref>."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **ServiceBusAdministrationClientBuilder**</br> implements <xref href=\"com.azure.core.client.traits.TokenCredentialTrait?alt=com.azure.core.client.traits.TokenCredentialTrait&text=TokenCredentialTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder?alt=com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder&text=ServiceBusAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.core.client.traits.AzureSasCredentialTrait?alt=com.azure.core.client.traits.AzureSasCredentialTrait&text=AzureSasCredentialTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder?alt=com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder&text=ServiceBusAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.core.client.traits.ConnectionStringTrait?alt=com.azure.core.client.traits.ConnectionStringTrait&text=ConnectionStringTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder?alt=com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder&text=ServiceBusAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.core.client.traits.HttpTrait?alt=com.azure.core.client.traits.HttpTrait&text=HttpTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder?alt=com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder&text=ServiceBusAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.core.client.traits.ConfigurationTrait?alt=com.azure.core.client.traits.ConfigurationTrait&text=ConfigurationTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder?alt=com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder&text=ServiceBusAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.core.client.traits.EndpointTrait?alt=com.azure.core.client.traits.EndpointTrait&text=EndpointTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder?alt=com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder&text=ServiceBusAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
constructors:
- uid: "com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder.ServiceBusAdministrationClientBuilder()"
fullName: "com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder.ServiceBusAdministrationClientBuilder()"
name: "ServiceBusAdministrationClientBuilder()"
nameWithType: "ServiceBusAdministrationClientBuilder.ServiceBusAdministrationClientBuilder()"
summary: "Constructs a builder with the default parameters."
syntax: "public ServiceBusAdministrationClientBuilder()"
desc: "Constructs a builder with the default parameters."
methods:
- uid: "com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder.addPolicy(com.azure.core.http.policy.HttpPipelinePolicy)"
fullName: "com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder.addPolicy(HttpPipelinePolicy policy)"
name: "addPolicy(HttpPipelinePolicy policy)"
nameWithType: "ServiceBusAdministrationClientBuilder.addPolicy(HttpPipelinePolicy policy)"
summary: "Adds a <xref uid=\"com.azure.core.http.policy.HttpPipelinePolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"pipeline policy\"></xref> to apply on each request sent."
parameters:
- description: "A <xref uid=\"com.azure.core.http.policy.HttpPipelinePolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"pipeline policy\"></xref>."
name: "policy"
type: "<xref href=\"com.azure.core.http.policy.HttpPipelinePolicy?alt=com.azure.core.http.policy.HttpPipelinePolicy&text=HttpPipelinePolicy\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ServiceBusAdministrationClientBuilder addPolicy(HttpPipelinePolicy policy)"
desc: "Adds a <xref uid=\"com.azure.core.http.policy.HttpPipelinePolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"pipeline policy\"></xref> to apply on each request sent.\n\n**Note:** It is important to understand the precedence order of the HttpTrait APIs. In particular, if a <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications."
returns:
description: "The updated <xref uid=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceBusAdministrationClientBuilder\"></xref> object."
type: "<xref href=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder?alt=com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder&text=ServiceBusAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder.buildAsyncClient()"
fullName: "com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder.buildAsyncClient()"
name: "buildAsyncClient()"
nameWithType: "ServiceBusAdministrationClientBuilder.buildAsyncClient()"
summary: "Creates a <xref uid=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceBusAdministrationAsyncClient\"></xref> based on options set in the builder."
syntax: "public ServiceBusAdministrationAsyncClient buildAsyncClient()"
desc: "Creates a <xref uid=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceBusAdministrationAsyncClient\"></xref> based on options set in the builder. Every time `buildAsyncClient` is invoked, a new instance of the client is created.\n\nIf <xref uid=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder.pipeline(com.azure.core.http.HttpPipeline)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"pipeline\"></xref> is set, then the `pipeline` and <xref uid=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder.endpoint(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"endpoint\"></xref> are used to create the <xref uid=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"client\"></xref>. All other builder settings are ignored."
returns:
description: "A <xref uid=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceBusAdministrationAsyncClient\"></xref> with the options set in the builder."
type: "<xref href=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationAsyncClient?alt=com.azure.messaging.servicebus.administration.ServiceBusAdministrationAsyncClient&text=ServiceBusAdministrationAsyncClient\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder.buildClient()"
fullName: "com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder.buildClient()"
name: "buildClient()"
nameWithType: "ServiceBusAdministrationClientBuilder.buildClient()"
summary: "Creates a <xref uid=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceBusAdministrationClient\"></xref> based on options set in the builder."
syntax: "public ServiceBusAdministrationClient buildClient()"
desc: "Creates a <xref uid=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceBusAdministrationClient\"></xref> based on options set in the builder. Every time `buildClient` is invoked, a new instance of the client is created.\n\nIf <xref uid=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder.pipeline(com.azure.core.http.HttpPipeline)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"pipeline\"></xref> is set, then the `pipeline` and <xref uid=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder.endpoint(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"endpoint\"></xref> are used to create the <xref uid=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"client\"></xref>. All other builder settings are ignored."
returns:
description: "A <xref uid=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceBusAdministrationClient\"></xref> with the options set in the builder."
type: "<xref href=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClient?alt=com.azure.messaging.servicebus.administration.ServiceBusAdministrationClient&text=ServiceBusAdministrationClient\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder.clientOptions(com.azure.core.util.ClientOptions)"
fullName: "com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder.clientOptions(ClientOptions clientOptions)"
name: "clientOptions(ClientOptions clientOptions)"
nameWithType: "ServiceBusAdministrationClientBuilder.clientOptions(ClientOptions clientOptions)"
summary: "Allows for setting common properties such as application ID, headers, proxy configuration, etc."
parameters:
- description: "A configured instance of <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpClientOptions\"></xref>."
name: "clientOptions"
type: "<xref href=\"com.azure.core.util.ClientOptions?alt=com.azure.core.util.ClientOptions&text=ClientOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ServiceBusAdministrationClientBuilder clientOptions(ClientOptions clientOptions)"
desc: "Allows for setting common properties such as application ID, headers, proxy configuration, etc. Note that it is recommended that this method be called with an instance of the <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpClientOptions\"></xref> class (a subclass of the <xref uid=\"com.azure.core.util.ClientOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ClientOptions\"></xref> base class). The HttpClientOptions subclass provides more configuration options suitable for HTTP clients, which is applicable for any class that implements this HttpTrait interface.\n\n**Note:** It is important to understand the precedence order of the HttpTrait APIs. In particular, if a <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications."
returns:
description: "The updated <xref uid=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceBusAdministrationClientBuilder\"></xref> object."
type: "<xref href=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder?alt=com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder&text=ServiceBusAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder.configuration(com.azure.core.util.Configuration)"
fullName: "com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder.configuration(Configuration configuration)"
name: "configuration(Configuration configuration)"
nameWithType: "ServiceBusAdministrationClientBuilder.configuration(Configuration configuration)"
summary: "Sets the configuration store that is used during construction of the service client."
parameters:
- description: "The configuration store used to"
name: "configuration"
type: "<xref href=\"com.azure.core.util.Configuration?alt=com.azure.core.util.Configuration&text=Configuration\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ServiceBusAdministrationClientBuilder configuration(Configuration configuration)"
desc: "Sets the configuration store that is used during construction of the service client. The default configuration store is a clone of the <xref uid=\"Configuration#getGlobalConfiguration()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"global\n configuration store\"></xref>, use <xref uid=\"com.azure.core.util.Configuration.NONE\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Configuration#NONE\"></xref> to bypass using configuration settings during construction."
returns:
description: "The updated <xref uid=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceBusAdministrationClientBuilder\"></xref> object."
type: "<xref href=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder?alt=com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder&text=ServiceBusAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder.connectionString(java.lang.String)"
fullName: "com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder.connectionString(String connectionString)"
name: "connectionString(String connectionString)"
nameWithType: "ServiceBusAdministrationClientBuilder.connectionString(String connectionString)"
summary: "Sets the connection string for a Service Bus namespace or a specific Service Bus resource."
parameters:
- description: "Connection string for a Service Bus namespace or a specific Service Bus resource."
name: "connectionString"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public ServiceBusAdministrationClientBuilder connectionString(String connectionString)"
desc: "Sets the connection string for a Service Bus namespace or a specific Service Bus resource."
returns:
description: "The updated <xref uid=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceBusAdministrationClientBuilder\"></xref> object."
type: "<xref href=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder?alt=com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder&text=ServiceBusAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder.credential(com.azure.core.credential.AzureSasCredential)"
fullName: "com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder.credential(AzureSasCredential credential)"
name: "credential(AzureSasCredential credential)"
nameWithType: "ServiceBusAdministrationClientBuilder.credential(AzureSasCredential credential)"
summary: "Sets the credential with Shared Access Signature for the Service Bus resource."
parameters:
- description: "<xref uid=\"com.azure.core.credential.AzureSasCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AzureSasCredential\"></xref> to be used for authentication."
name: "credential"
type: "<xref href=\"com.azure.core.credential.AzureSasCredential?alt=com.azure.core.credential.AzureSasCredential&text=AzureSasCredential\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ServiceBusAdministrationClientBuilder credential(AzureSasCredential credential)"
desc: "Sets the credential with Shared Access Signature for the Service Bus resource. Refer to [ Service Bus access control with Shared Access Signatures][Service Bus access control with Shared Access Signatures].\n\n\n[Service Bus access control with Shared Access Signatures]: https://docs.microsoft.com/azure/service-bus-messaging/service-bus-sas"
returns:
description: "The updated <xref uid=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceBusAdministrationClientBuilder\"></xref> object."
type: "<xref href=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder?alt=com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder&text=ServiceBusAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder.credential(com.azure.core.credential.TokenCredential)"
fullName: "com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder.credential(TokenCredential credential)"
name: "credential(TokenCredential credential)"
nameWithType: "ServiceBusAdministrationClientBuilder.credential(TokenCredential credential)"
summary: "Sets the <xref uid=\"com.azure.core.credential.TokenCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TokenCredential\"></xref> used to authorize requests sent to the service."
parameters:
- description: "<xref uid=\"com.azure.core.credential.TokenCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TokenCredential\"></xref> used to authorize requests sent to the service."
name: "credential"
type: "<xref href=\"com.azure.core.credential.TokenCredential?alt=com.azure.core.credential.TokenCredential&text=TokenCredential\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ServiceBusAdministrationClientBuilder credential(TokenCredential credential)"
desc: "Sets the <xref uid=\"com.azure.core.credential.TokenCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TokenCredential\"></xref> used to authorize requests sent to the service. Refer to the Azure SDK for Java [identity and authentication][] documentation for more details on proper usage of the <xref uid=\"com.azure.core.credential.TokenCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TokenCredential\"></xref> type.\n\n\n[identity and authentication]: https://aka.ms/azsdk/java/docs/identity"
returns:
description: "The updated <xref uid=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceBusAdministrationClientBuilder\"></xref> object."
type: "<xref href=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder?alt=com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder&text=ServiceBusAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder.credential(java.lang.String,com.azure.core.credential.TokenCredential)"
fullName: "com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder.credential(String fullyQualifiedNamespace, TokenCredential credential)"
name: "credential(String fullyQualifiedNamespace, TokenCredential credential)"
nameWithType: "ServiceBusAdministrationClientBuilder.credential(String fullyQualifiedNamespace, TokenCredential credential)"
summary: "Sets the credential used to authenticate HTTP requests to the Service Bus namespace."
parameters:
- description: "for the Service Bus."
name: "fullyQualifiedNamespace"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "<xref uid=\"com.azure.core.credential.TokenCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TokenCredential\"></xref> to be used for authentication."
name: "credential"
type: "<xref href=\"com.azure.core.credential.TokenCredential?alt=com.azure.core.credential.TokenCredential&text=TokenCredential\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ServiceBusAdministrationClientBuilder credential(String fullyQualifiedNamespace, TokenCredential credential)"
desc: "Sets the credential used to authenticate HTTP requests to the Service Bus namespace."
returns:
description: "The updated <xref uid=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceBusAdministrationClientBuilder\"></xref> object."
type: "<xref href=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder?alt=com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder&text=ServiceBusAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder.endpoint(java.lang.String)"
fullName: "com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder.endpoint(String endpoint)"
name: "endpoint(String endpoint)"
nameWithType: "ServiceBusAdministrationClientBuilder.endpoint(String endpoint)"
summary: "Sets the service endpoint for the Service Bus namespace."
parameters:
- description: "The URL of the Service Bus namespace."
name: "endpoint"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public ServiceBusAdministrationClientBuilder endpoint(String endpoint)"
desc: "Sets the service endpoint for the Service Bus namespace."
returns:
description: "The updated <xref uid=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceBusAdministrationClientBuilder\"></xref> object."
type: "<xref href=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder?alt=com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder&text=ServiceBusAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder.httpClient(com.azure.core.http.HttpClient)"
fullName: "com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder.httpClient(HttpClient client)"
name: "httpClient(HttpClient client)"
nameWithType: "ServiceBusAdministrationClientBuilder.httpClient(HttpClient client)"
summary: "Sets the <xref uid=\"com.azure.core.http.HttpClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpClient\"></xref> to use for sending and receiving requests to and from the service."
parameters:
- description: "The <xref uid=\"com.azure.core.http.HttpClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpClient\"></xref> to use for requests."
name: "client"
type: "<xref href=\"com.azure.core.http.HttpClient?alt=com.azure.core.http.HttpClient&text=HttpClient\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ServiceBusAdministrationClientBuilder httpClient(HttpClient client)"
desc: "Sets the <xref uid=\"com.azure.core.http.HttpClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpClient\"></xref> to use for sending and receiving requests to and from the service.\n\n**Note:** It is important to understand the precedence order of the HttpTrait APIs. In particular, if a <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications."
returns:
description: "The updated <xref uid=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceBusAdministrationClientBuilder\"></xref> object."
type: "<xref href=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder?alt=com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder&text=ServiceBusAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder.httpLogOptions(com.azure.core.http.policy.HttpLogOptions)"
fullName: "com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder.httpLogOptions(HttpLogOptions logOptions)"
name: "httpLogOptions(HttpLogOptions logOptions)"
nameWithType: "ServiceBusAdministrationClientBuilder.httpLogOptions(HttpLogOptions logOptions)"
summary: "Sets the <xref uid=\"com.azure.core.http.policy.HttpLogOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"logging configuration\"></xref> to use when sending and receiving requests to and from the service."
parameters:
- description: "The <xref uid=\"com.azure.core.http.policy.HttpLogOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"logging configuration\"></xref> to use when sending and receiving requests to\n and from the service."
name: "logOptions"
type: "<xref href=\"com.azure.core.http.policy.HttpLogOptions?alt=com.azure.core.http.policy.HttpLogOptions&text=HttpLogOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ServiceBusAdministrationClientBuilder httpLogOptions(HttpLogOptions logOptions)"
desc: "Sets the <xref uid=\"com.azure.core.http.policy.HttpLogOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"logging configuration\"></xref> to use when sending and receiving requests to and from the service. If a `logLevel` is not provided, default value of <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpLogDetailLevel#NONE\"></xref> is set.\n\n**Note:** It is important to understand the precedence order of the HttpTrait APIs. In particular, if a <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications."
returns:
description: "The updated <xref uid=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceBusAdministrationClientBuilder\"></xref> object."
type: "<xref href=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder?alt=com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder&text=ServiceBusAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder.pipeline(com.azure.core.http.HttpPipeline)"
fullName: "com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder.pipeline(HttpPipeline pipeline)"
name: "pipeline(HttpPipeline pipeline)"
nameWithType: "ServiceBusAdministrationClientBuilder.pipeline(HttpPipeline pipeline)"
summary: "Sets the <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> to use for the service client."
parameters:
- description: "<xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> to use for sending service requests and receiving responses."
name: "pipeline"
type: "<xref href=\"com.azure.core.http.HttpPipeline?alt=com.azure.core.http.HttpPipeline&text=HttpPipeline\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ServiceBusAdministrationClientBuilder pipeline(HttpPipeline pipeline)"
desc: "Sets the <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> to use for the service client.\n\n**Note:** It is important to understand the precedence order of the HttpTrait APIs. In particular, if a <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.\n\nThe <xref uid=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder.endpoint(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"endpoint\"></xref> is not ignored when `pipeline` is set."
returns:
description: "The updated <xref uid=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceBusAdministrationClientBuilder\"></xref> object."
type: "<xref href=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder?alt=com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder&text=ServiceBusAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder.retryOptions(com.azure.core.http.policy.RetryOptions)"
fullName: "com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder.retryOptions(RetryOptions retryOptions)"
name: "retryOptions(RetryOptions retryOptions)"
nameWithType: "ServiceBusAdministrationClientBuilder.retryOptions(RetryOptions retryOptions)"
summary: "Sets the <xref uid=\"com.azure.core.http.policy.RetryOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RetryOptions\"></xref> for all the requests made through the client."
parameters:
- description: "The <xref uid=\"com.azure.core.http.policy.RetryOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RetryOptions\"></xref> to use for all the requests made through the client."
name: "retryOptions"
type: "<xref href=\"com.azure.core.http.policy.RetryOptions?alt=com.azure.core.http.policy.RetryOptions&text=RetryOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ServiceBusAdministrationClientBuilder retryOptions(RetryOptions retryOptions)"
desc: "Sets the <xref uid=\"com.azure.core.http.policy.RetryOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RetryOptions\"></xref> for all the requests made through the client.\n\n**Note:** It is important to understand the precedence order of the HttpTrait APIs. In particular, if a <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.\n\nSetting this is mutually exclusive with using <xref uid=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder.retryPolicy(com.azure.core.http.policy.HttpPipelinePolicy)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#retryPolicy(HttpPipelinePolicy)\"></xref>."
returns:
description: "The updated <xref uid=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceBusAdministrationClientBuilder\"></xref> object."
type: "<xref href=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder?alt=com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder&text=ServiceBusAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder.retryPolicy(com.azure.core.http.policy.HttpPipelinePolicy)"
fullName: "com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder.retryPolicy(HttpPipelinePolicy retryPolicy)"
name: "retryPolicy(HttpPipelinePolicy retryPolicy)"
nameWithType: "ServiceBusAdministrationClientBuilder.retryPolicy(HttpPipelinePolicy retryPolicy)"
summary: "Sets the <xref uid=\"com.azure.core.http.policy.HttpPipelinePolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipelinePolicy\"></xref> that is used when each request is sent."
parameters:
- description: "The user's retry policy applied to each request."
name: "retryPolicy"
type: "<xref href=\"com.azure.core.http.policy.HttpPipelinePolicy?alt=com.azure.core.http.policy.HttpPipelinePolicy&text=HttpPipelinePolicy\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ServiceBusAdministrationClientBuilder retryPolicy(HttpPipelinePolicy retryPolicy)"
desc: "Sets the <xref uid=\"com.azure.core.http.policy.HttpPipelinePolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipelinePolicy\"></xref> that is used when each request is sent. The default retry policy will be used if not provided <xref uid=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder.buildAsyncClient()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#buildAsyncClient()\"></xref> to build <xref uid=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceBusAdministrationClient\"></xref> or <xref uid=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceBusAdministrationAsyncClient\"></xref>. Setting this is mutually exclusive with using <xref uid=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder.retryOptions(com.azure.core.http.policy.RetryOptions)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#retryOptions(RetryOptions)\"></xref>."
returns:
description: "The updated <xref uid=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceBusAdministrationClientBuilder\"></xref> object."
type: "<xref href=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder?alt=com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder&text=ServiceBusAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder.serviceVersion(com.azure.messaging.servicebus.ServiceBusServiceVersion)"
fullName: "com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder.serviceVersion(ServiceBusServiceVersion serviceVersion)"
name: "serviceVersion(ServiceBusServiceVersion serviceVersion)"
nameWithType: "ServiceBusAdministrationClientBuilder.serviceVersion(ServiceBusServiceVersion serviceVersion)"
summary: "Sets the <xref uid=\"com.azure.messaging.servicebus.ServiceBusServiceVersion\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceBusServiceVersion\"></xref> that is used."
parameters:
- description: "Service version to use."
name: "serviceVersion"
type: "<xref href=\"com.azure.messaging.servicebus.ServiceBusServiceVersion?alt=com.azure.messaging.servicebus.ServiceBusServiceVersion&text=ServiceBusServiceVersion\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ServiceBusAdministrationClientBuilder serviceVersion(ServiceBusServiceVersion serviceVersion)"
desc: "Sets the <xref uid=\"com.azure.messaging.servicebus.ServiceBusServiceVersion\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceBusServiceVersion\"></xref> that is used. By default <xref uid=\"com.azure.messaging.servicebus.ServiceBusServiceVersion.getLatest()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceBusServiceVersion#getLatest()\"></xref> is used when none is specified."
returns:
description: "The updated <xref uid=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceBusAdministrationClientBuilder\"></xref> object."
type: "<xref href=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder?alt=com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder&text=ServiceBusAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "This class provides a fluent builder API to help aid the configuration and instantiation of <xref uid=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceBusAdministrationClient\"></xref> and <xref uid=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceBusAdministrationAsyncClient\"></xref>. Call <xref uid=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder.buildClient()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"buildClient()\"></xref> and <xref uid=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder.buildAsyncClient()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"buildAsyncClient()\"></xref> respectively to construct an instance of the desired client.\n\n**Credentials are required** to perform operations against Azure Service Bus. They can be set by using one of the following methods:\n\n * <xref uid=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder.connectionString(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#connectionString(String)\"></xref> with a Service Bus *namespace* connection string.\n * <xref uid=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder.credential(java.lang.String,com.azure.core.credential.TokenCredential)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#credential(String, TokenCredential)\"></xref> with the fully qualified Service Bus namespace and a set of credentials authorized to use the namespace.\n * <xref uid=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder.credential(com.azure.core.credential.TokenCredential)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#credential(TokenCredential)\"></xref> and <xref uid=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder.credential(com.azure.core.credential.AzureSasCredential)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#credential(AzureSasCredential)\"></xref> overloads can be used with its respective credentials. In addition, <xref uid=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder.endpoint(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#endpoint(String)\"></xref> must be set.\n\nThe credential used in the following samples is `DefaultAzureCredential` for authentication. It is appropriate for most scenarios, including local development and production environments. Additionally, we recommend using [managed identity][] for authentication in production environments. You can find more information on different ways of authenticating and their corresponding credential types in the [Azure Identity documentation][].\n\n**Sample: Create the sync client**\n\nThe following code sample demonstrates the creation of the synchronous administration client.\n\n```java\nHttpLogOptions logOptions = new HttpLogOptions()\n .setLogLevel(HttpLogDetailLevel.HEADERS);\n\n // DefaultAzureCredential creates a credential based on the environment it is executed in.\n TokenCredential tokenCredential = new DefaultAzureCredentialBuilder().build();\n\n // 'fullyQualifiedNamespace' will look similar to \"{your-namespace}.servicebus.windows.net\"\n ServiceBusAdministrationClient client = new ServiceBusAdministrationClientBuilder()\n .credential(fullyQualifiedNamespace, tokenCredential)\n .httpLogOptions(logOptions)\n .buildClient();\n```\n\n**Sample: Create the async client using Azure Identity**\n\nThe follow code sample demonstrates the creation of the async administration client.\n\n```java\n// DefaultAzureCredential creates a credential based on the environment it is executed in.\n TokenCredential credential = new DefaultAzureCredentialBuilder().build();\n\n // 'fullyQualifiedNamespace' will look similar to \"{your-namespace}.servicebus.windows.net\"\n ServiceBusAdministrationAsyncClient client = new ServiceBusAdministrationClientBuilder()\n .credential(fullyQualifiedNamespace, new DefaultAzureCredentialBuilder().build())\n .buildAsyncClient();\n```\n\n**Sample: Create the async client**\n\nThe follow code sample demonstrates the creation of the async administration client with retry options and HTTP log options configured.\n\n```java\n// DefaultAzureCredential creates a credential based on the environment it is executed in.\n TokenCredential credential = new DefaultAzureCredentialBuilder().build();\n\n RetryOptions retryOptions = new RetryOptions(new FixedDelayOptions(4, Duration.ofSeconds(20)));\n\n // \"<<fully-qualified-namespace>>\" will look similar to \"{your-namespace}.servicebus.windows.net\"\n ServiceBusAdministrationAsyncClient client = new ServiceBusAdministrationClientBuilder()\n .credential(\"<<fully-qualified-namespace>>\", credential)\n .retryOptions(retryOptions)\n .httpLogOptions(new HttpLogOptions().setLogLevel(HttpLogDetailLevel.HEADERS))\n .buildAsyncClient();\n```\n\n\n[managed identity]: https://learn.microsoft.com/azure/active-directory/managed-identities-azure-resources/\n[Azure Identity documentation]: https://learn.microsoft.com/java/api/overview/azure/identity-readme"
implements:
- "<xref href=\"com.azure.core.client.traits.AzureSasCredentialTrait?alt=com.azure.core.client.traits.AzureSasCredentialTrait&text=AzureSasCredentialTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder?alt=com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder&text=ServiceBusAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
- "<xref href=\"com.azure.core.client.traits.ConfigurationTrait?alt=com.azure.core.client.traits.ConfigurationTrait&text=ConfigurationTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder?alt=com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder&text=ServiceBusAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
- "<xref href=\"com.azure.core.client.traits.ConnectionStringTrait?alt=com.azure.core.client.traits.ConnectionStringTrait&text=ConnectionStringTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder?alt=com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder&text=ServiceBusAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
- "<xref href=\"com.azure.core.client.traits.EndpointTrait?alt=com.azure.core.client.traits.EndpointTrait&text=EndpointTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder?alt=com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder&text=ServiceBusAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
- "<xref href=\"com.azure.core.client.traits.HttpTrait?alt=com.azure.core.client.traits.HttpTrait&text=HttpTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder?alt=com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder&text=ServiceBusAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
- "<xref href=\"com.azure.core.client.traits.TokenCredentialTrait?alt=com.azure.core.client.traits.TokenCredentialTrait&text=TokenCredentialTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder?alt=com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder&text=ServiceBusAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
metadata: {}
package: "com.azure.messaging.servicebus.administration"
artifact: com.azure:azure-messaging-servicebus:7.17.1