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
|
# -------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for
# license information.
# --------------------------------------------------------------------------
"""
FILE: job_queue_crud_ops.py
DESCRIPTION:
These samples demonstrates how to create Job Queues used in ACS JobRouter.
You need a valid connection string to an Azure Communication Service to execute the sample
USAGE:
python job_queue_crud_ops.py
Set the environment variables with your own values before running the sample:
1) AZURE_COMMUNICATION_SERVICE_CONNECTION_STRING - Communication Service connection string
"""
import os
class JobQueueSamples(object):
connection_string = os.environ["AZURE_COMMUNICATION_SERVICE_CONNECTION_STRING"]
_job_queue_id = "sample_q_policy"
_distribution_policy_id = "sample_dp_policy"
def setup_distribution_policy(self):
connection_string = self.connection_string
distribution_policy_id = self._distribution_policy_id
from azure.communication.jobrouter import JobRouterAdministrationClient
from azure.communication.jobrouter.models import LongestIdleMode, DistributionPolicy
router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str=connection_string)
distribution_policy = router_admin_client.upsert_distribution_policy(
distribution_policy_id,
DistributionPolicy(
offer_expires_after_seconds=10 * 60,
mode=LongestIdleMode(min_concurrent_offers=1, max_concurrent_offers=1),
),
)
print(f"Sample setup completed: Created distribution policy")
def create_queue(self):
connection_string = self.connection_string
job_queue_id = self._job_queue_id
distribution_policy_id = self._distribution_policy_id
# [START create_queue]
from azure.communication.jobrouter import (
JobRouterAdministrationClient,
)
from azure.communication.jobrouter.models import (
RouterQueue,
)
# set `connection_string` to an existing ACS endpoint
router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str=connection_string)
print("JobRouterAdministrationClient created successfully!")
job_queue: RouterQueue = router_admin_client.upsert_queue(
job_queue_id, RouterQueue(distribution_policy_id=distribution_policy_id, name="My job queue")
)
print(f"Job queue successfully created with id: {job_queue.id}")
# [END create_queue]
def update_queue(self):
connection_string = self.connection_string
job_queue_id = self._job_queue_id
# [START update_queue]
from azure.communication.jobrouter import (
JobRouterAdministrationClient,
)
from azure.communication.jobrouter.models import (
RouterQueue,
)
# set `connection_string` to an existing ACS endpoint
router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str=connection_string)
print("JobRouterAdministrationClient created successfully!")
updated_job_queue: RouterQueue = router_admin_client.upsert_queue(
job_queue_id, labels={"Additional-Queue-Label": "ChatQueue"}
)
print(f"Router queue successfully update with labels {updated_job_queue.labels}")
# [END update_queue]
def get_queue(self):
connection_string = self.connection_string
job_queue_id = self._job_queue_id
# [START get_queue]
from azure.communication.jobrouter import JobRouterAdministrationClient
router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str=connection_string)
job_queue = router_admin_client.get_queue(job_queue_id)
print(f"Successfully fetched router queue with id: {job_queue.id}")
# [END get_queue]
def get_queue_statistics(self):
connection_string = self.connection_string
job_queue_id = self._job_queue_id
# [START get_queue_statistics]
from azure.communication.jobrouter import JobRouterClient
from azure.communication.jobrouter.models import RouterQueueStatistics
router_client: JobRouterClient = JobRouterClient.from_connection_string(conn_str=connection_string)
job_queue_statistics: RouterQueueStatistics = router_client.get_queue_statistics(job_queue_id)
print(f"Successfully fetched queue statistics router queue: {job_queue_statistics}")
# [END get_queue_statistics]
def list_queues(self):
connection_string = self.connection_string
# [START list_queues]
from azure.communication.jobrouter import JobRouterAdministrationClient
router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str=connection_string)
job_queue_iterator = router_admin_client.list_queues()
for q in job_queue_iterator:
print(f"Retrieved queue policy with id: {q.id}")
print(f"Successfully completed fetching job queues")
# [END list_queues]
def list_queues_batched(self):
connection_string = self.connection_string
# [START list_queues_batched]
from azure.communication.jobrouter import JobRouterAdministrationClient
router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str=connection_string)
job_queue_iterator = router_admin_client.list_queues(results_per_page=10)
for queue_page in job_queue_iterator.by_page():
job_queues_in_page = list(queue_page)
print(f"Retrieved {len(job_queues_in_page)} queues in current page")
for q in job_queues_in_page:
print(f"Retrieved queue policy with id: {q.id}")
print(f"Successfully completed fetching job queues")
# [END list_queues_batched]
def clean_up(self):
connection_string = self.connection_string
job_queue_id = self._job_queue_id
# [START delete_queue]
from azure.communication.jobrouter import JobRouterAdministrationClient
router_admin_client = JobRouterAdministrationClient.from_connection_string(conn_str=connection_string)
router_admin_client.delete_queue(job_queue_id)
# [END delete_queue]
router_admin_client.delete_distribution_policy(self._distribution_policy_id)
if __name__ == "__main__":
sample = JobQueueSamples()
sample.setup_distribution_policy()
sample.create_queue()
sample.update_queue()
sample.get_queue()
sample.get_queue_statistics()
sample.list_queues()
sample.list_queues_batched()
sample.clean_up()
|
