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 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421
|
# ------------------------------------
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
# ------------------------------------
"""Customize generated code here.
Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize
"""
from typing import Optional, Any, Dict, List, IO
from azure.core.credentials import AzureKeyCredential
from azure.core.tracing.decorator_async import distributed_trace_async
from azure.core.exceptions import (
ClientAuthenticationError,
HttpResponseError,
ResourceExistsError,
ResourceNotFoundError,
ResourceNotModifiedError,
map_error,
)
from azure.core.utils import case_insensitive_dict
from ._operations import (
WebPubSubServiceClientOperationsMixin as WebPubSubServiceClientOperationsMixinGenerated,
JSON,
build_send_to_all_request,
build_send_to_connection_request,
build_send_to_user_request,
build_send_to_group_request,
)
from ..._operations._patch import get_token_by_key
class WebPubSubServiceClientOperationsMixin(WebPubSubServiceClientOperationsMixinGenerated):
@distributed_trace_async
async def get_client_access_token( # pylint: disable=arguments-differ
self,
*,
user_id: Optional[str] = None,
roles: Optional[List[str]] = None,
minutes_to_expire: Optional[int] = 60,
jwt_headers: Dict[str, Any] = None,
**kwargs: Any
) -> JSON:
"""Generate token for the client to connect Azure Web PubSub service.
Generate token for the client to connect Azure Web PubSub service.
:keyword user_id: User Id.
:paramtype user_id: str
:keyword roles: Roles that the connection with the generated token will have.
:paramtype roles: list[str]
:keyword minutes_to_expire: The expire time of the generated token.
:paramtype minutes_to_expire: int
:keyword dict[str, any] jwt_headers: Any headers you want to pass to jwt encoding.
:keyword api_version: Api Version. The default value is "2021-10-01". Note that overriding this
default value may result in unsupported behavior.
:paramtype api_version: str
:return: JSON object
:rtype: JSON
:raises: ~azure.core.exceptions.HttpResponseError
Example:
.. code-block:: python
>>> get_client_access_token()
{
'baseUrl': 'wss://contoso.com/api/webpubsub/client/hubs/theHub',
'token': '<access-token>...',
'url': 'wss://contoso.com/api/webpubsub/client/hubs/theHub?access_token=<access-token>...'
}
"""
endpoint = self._config.endpoint.lower()
if not endpoint.startswith("http://") and not endpoint.startswith("https://"):
raise ValueError(
"Invalid endpoint: '{}' has unknown scheme - expected 'http://' or 'https://'".format(endpoint)
)
# Ensure endpoint has no trailing slash
endpoint = endpoint.rstrip("/")
# Switch from http(s) to ws(s) scheme
client_endpoint = "ws" + endpoint[4:]
hub = self._config.hub
client_url = "{}/client/hubs/{}".format(client_endpoint, hub)
if isinstance(self._config.credential, AzureKeyCredential):
token = get_token_by_key(
endpoint,
hub,
self._config.credential.key,
user_id=user_id,
roles=roles,
minutes_to_expire=minutes_to_expire,
jwt_headers=jwt_headers or {},
**kwargs
)
else:
access_token = await super().get_client_access_token(
user_id=user_id, roles=roles, minutes_to_expire=minutes_to_expire, **kwargs
)
token = access_token.get("token")
return {
"baseUrl": client_url,
"token": token,
"url": "{}?access_token={}".format(client_url, token),
}
get_client_access_token.metadata = {"url": "/api/hubs/{hub}/:generateToken"} # type: ignore
@distributed_trace_async
async def send_to_all( # pylint: disable=inconsistent-return-statements
self, message: IO, *, excluded: Optional[List[str]] = None, filter: Optional[str] = None, **kwargs: Any
) -> None:
"""Broadcast content inside request body to all the connected client connections.
Broadcast content inside request body to all the connected client connections.
:param message: The payload body. Required.
:type message: IO
:keyword excluded: Excluded connection Ids. Default value is None.
:paramtype excluded: list[str]
:keyword filter: Following OData filter syntax to filter out the subscribers receiving the
messages. Default value is None.
:paramtype filter: str
:return: None
:rtype: None
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = kwargs.pop("params", {}) or {}
content_type = kwargs.pop("content_type", _headers.pop("Content-Type", "application/json")) # type: str
cls = kwargs.pop("cls", None) # type: ClsType[None]
_json = None
_content = None
content_type = content_type or ""
if content_type.split(";")[0] in ["application/json"]:
_json = message
elif content_type.split(";")[0] in ["application/octet-stream", "text/plain"]:
_content = message
else:
raise ValueError(
"The content_type '{}' is not one of the allowed values: "
"['application/json', 'application/octet-stream', 'text/plain']".format(content_type)
)
request = build_send_to_all_request(
hub=self._config.hub,
excluded=excluded,
filter=filter,
content_type=content_type,
api_version=self._config.api_version,
content=_content,
json=_json,
headers=_headers,
params=_params,
)
path_format_arguments = {
"Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True),
}
request.url = self._client.format_url(request.url, **path_format_arguments) # type: ignore
pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access
request, stream=False, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [202]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response)
if cls:
return cls(pipeline_response, None, {})
@distributed_trace_async
async def send_to_group( # pylint: disable=inconsistent-return-statements
self,
group: str,
message: IO,
*,
excluded: Optional[List[str]] = None,
filter: Optional[str] = None,
**kwargs: Any
) -> None:
"""Send content inside request body to a group of connections.
Send content inside request body to a group of connections.
:param group: Target group name, which length should be greater than 0 and less than 1025.
Required.
:type group: str
:param message: The payload body. Required.
:type message: IO
:keyword excluded: Excluded connection Ids. Default value is None.
:paramtype excluded: list[str]
:keyword filter: Following OData filter syntax to filter out the subscribers receiving the
messages. Default value is None.
:paramtype filter: str
:return: None
:rtype: None
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = kwargs.pop("params", {}) or {}
content_type = kwargs.pop("content_type", _headers.pop("Content-Type", "application/json")) # type: str
cls = kwargs.pop("cls", None) # type: ClsType[None]
_json = None
_content = None
content_type = content_type or ""
if content_type.split(";")[0] in ["application/json"]:
_json = message
elif content_type.split(";")[0] in ["application/octet-stream", "text/plain"]:
_content = message
else:
raise ValueError(
"The content_type '{}' is not one of the allowed values: "
"['application/json', 'application/octet-stream', 'text/plain']".format(content_type)
)
request = build_send_to_group_request(
group=group,
hub=self._config.hub,
excluded=excluded,
filter=filter,
content_type=content_type,
api_version=self._config.api_version,
content=_content,
json=_json,
headers=_headers,
params=_params,
)
path_format_arguments = {
"Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True),
}
request.url = self._client.format_url(request.url, **path_format_arguments) # type: ignore
pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access
request, stream=False, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [202]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response)
if cls:
return cls(pipeline_response, None, {})
@distributed_trace_async
async def send_to_connection( # pylint: disable=inconsistent-return-statements
self, connection_id: str, message: IO, **kwargs: Any
) -> None:
"""Send content inside request body to the specific connection.
Send content inside request body to the specific connection.
:param connection_id: The connection Id. Required.
:type connection_id: str
:param message: The payload body. Required.
:type message: IO
:return: None
:rtype: None
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = kwargs.pop("params", {}) or {}
content_type = kwargs.pop("content_type", _headers.pop("Content-Type", "application/json")) # type: str
cls = kwargs.pop("cls", None) # type: ClsType[None]
_json = None
_content = None
content_type = content_type or ""
if content_type.split(";")[0] in ["application/json"]:
_json = message
elif content_type.split(";")[0] in ["application/octet-stream", "text/plain"]:
_content = message
else:
raise ValueError(
"The content_type '{}' is not one of the allowed values: "
"['application/json', 'application/octet-stream', 'text/plain']".format(content_type)
)
request = build_send_to_connection_request(
connection_id=connection_id,
hub=self._config.hub,
content_type=content_type,
api_version=self._config.api_version,
content=_content,
json=_json,
headers=_headers,
params=_params,
)
path_format_arguments = {
"Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True),
}
request.url = self._client.format_url(request.url, **path_format_arguments) # type: ignore
pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access
request, stream=False, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [202]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response)
if cls:
return cls(pipeline_response, None, {})
@distributed_trace_async
async def send_to_user( # pylint: disable=inconsistent-return-statements
self, user_id: str, message: IO, *, filter: Optional[str] = None, **kwargs: Any
) -> None:
"""Send content inside request body to the specific user.
Send content inside request body to the specific user.
:param user_id: The user Id. Required.
:type user_id: str
:param message: The payload body. Required.
:type message: IO
:keyword filter: Following OData filter syntax to filter out the subscribers receiving the
messages. Default value is None.
:paramtype filter: str
:return: None
:rtype: None
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = kwargs.pop("params", {}) or {}
content_type = kwargs.pop("content_type", _headers.pop("Content-Type", "application/json")) # type: str
cls = kwargs.pop("cls", None) # type: ClsType[None]
_json = None
_content = None
content_type = content_type or ""
if content_type.split(";")[0] in ["application/json"]:
_json = message
elif content_type.split(";")[0] in ["application/octet-stream", "text/plain"]:
_content = message
else:
raise ValueError(
"The content_type '{}' is not one of the allowed values: "
"['application/json', 'application/octet-stream', 'text/plain']".format(content_type)
)
request = build_send_to_user_request(
user_id=user_id,
hub=self._config.hub,
filter=filter,
content_type=content_type,
api_version=self._config.api_version,
content=_content,
json=_json,
headers=_headers,
params=_params,
)
path_format_arguments = {
"Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True),
}
request.url = self._client.format_url(request.url, **path_format_arguments) # type: ignore
pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access
request, stream=False, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [202]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response)
if cls:
return cls(pipeline_response, None, {})
__all__: List[str] = [
"WebPubSubServiceClientOperationsMixin"
] # Add all objects you want publicly available to users at this package level
def patch_sdk():
"""Do not remove from this file.
`patch_sdk` is a last resort escape hatch that allows you to do customizations
you can't accomplish using the techniques described in
https://aka.ms/azsdk/python/dpcodegen/python/customize
"""
|