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
|
# --------------------------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
# --------------------------------------------------------------------------------------------
# Generated file, DO NOT EDIT
# Changes may cause incorrect behavior and will be lost if the code is regenerated.
# --------------------------------------------------------------------------------------------
from msrest import Serializer, Deserializer
from ...client import Client
from . import models
class AuditClient(Client):
"""Audit
:param str base_url: Service URL
:param Authentication creds: Authenticated credentials.
"""
def __init__(self, base_url=None, creds=None):
super(AuditClient, self).__init__(base_url, creds)
client_models = {k: v for k, v in models.__dict__.items() if isinstance(v, type)}
self._serialize = Serializer(client_models)
self._deserialize = Deserializer(client_models)
resource_area_identifier = '94ff054d-5ee1-413d-9341-3f4a7827de2e'
def get_actions(self, area_name=None):
"""GetActions.
[Preview API] Get all auditable actions filterable by area.
:param str area_name: Optional. Get actions scoped to area
:rtype: [AuditActionInfo]
"""
query_parameters = {}
if area_name is not None:
query_parameters['areaName'] = self._serialize.query('area_name', area_name, 'str')
response = self._send(http_method='GET',
location_id='6fa30b9a-9558-4e3b-a95f-a12572caa6e6',
version='6.0-preview.1',
query_parameters=query_parameters)
return self._deserialize('[AuditActionInfo]', self._unwrap_collection(response))
def query_log(self, start_time=None, end_time=None, batch_size=None, continuation_token=None, skip_aggregation=None):
"""QueryLog.
[Preview API] Queries audit log entries
:param datetime start_time: Start time of download window. Optional
:param datetime end_time: End time of download window. Optional
:param int batch_size: Max number of results to return. Optional
:param str continuation_token: Token used for returning next set of results from previous query. Optional
:param bool skip_aggregation: Skips aggregating events and leaves them as individual entries instead. By default events are aggregated. Event types that are aggregated: AuditLog.AccessLog.
:rtype: :class:`<AuditLogQueryResult> <azure.devops.v6_0.audit.models.AuditLogQueryResult>`
"""
query_parameters = {}
if start_time is not None:
query_parameters['startTime'] = self._serialize.query('start_time', start_time, 'iso-8601')
if end_time is not None:
query_parameters['endTime'] = self._serialize.query('end_time', end_time, 'iso-8601')
if batch_size is not None:
query_parameters['batchSize'] = self._serialize.query('batch_size', batch_size, 'int')
if continuation_token is not None:
query_parameters['continuationToken'] = self._serialize.query('continuation_token', continuation_token, 'str')
if skip_aggregation is not None:
query_parameters['skipAggregation'] = self._serialize.query('skip_aggregation', skip_aggregation, 'bool')
response = self._send(http_method='GET',
location_id='4e5fa14f-7097-4b73-9c85-00abc7353c61',
version='6.0-preview.1',
query_parameters=query_parameters)
return self._deserialize('AuditLogQueryResult', response)
def download_log(self, format, start_time=None, end_time=None, **kwargs):
"""DownloadLog.
[Preview API] Downloads audit log entries.
:param str format: File format for download. Can be "json" or "csv".
:param datetime start_time: Start time of download window. Optional
:param datetime end_time: End time of download window. Optional
:rtype: object
"""
query_parameters = {}
if format is not None:
query_parameters['format'] = self._serialize.query('format', format, 'str')
if start_time is not None:
query_parameters['startTime'] = self._serialize.query('start_time', start_time, 'iso-8601')
if end_time is not None:
query_parameters['endTime'] = self._serialize.query('end_time', end_time, 'iso-8601')
response = self._send(http_method='GET',
location_id='b7b98a76-04e8-4f4d-ac72-9d46492caaac',
version='6.0-preview.1',
query_parameters=query_parameters,
accept_media_type='application/octet-stream')
if "callback" in kwargs:
callback = kwargs["callback"]
else:
callback = None
return self._client.stream_download(response, callback=callback)
def create_stream(self, stream, days_to_backfill):
"""CreateStream.
[Preview API] Create new Audit Stream
:param :class:`<AuditStream> <azure.devops.v6_0.audit.models.AuditStream>` stream: Stream entry
:param int days_to_backfill: The number of days of previously recorded audit data that will be replayed into the stream. A value of zero will result in only new events being streamed.
:rtype: :class:`<AuditStream> <azure.devops.v6_0.audit.models.AuditStream>`
"""
query_parameters = {}
if days_to_backfill is not None:
query_parameters['daysToBackfill'] = self._serialize.query('days_to_backfill', days_to_backfill, 'int')
content = self._serialize.body(stream, 'AuditStream')
response = self._send(http_method='POST',
location_id='77d60bf9-1882-41c5-a90d-3a6d3c13fd3b',
version='6.0-preview.1',
query_parameters=query_parameters,
content=content)
return self._deserialize('AuditStream', response)
def delete_stream(self, stream_id):
"""DeleteStream.
[Preview API] Delete Audit Stream
:param int stream_id: Id of stream entry to delete
"""
route_values = {}
if stream_id is not None:
route_values['streamId'] = self._serialize.url('stream_id', stream_id, 'int')
self._send(http_method='DELETE',
location_id='77d60bf9-1882-41c5-a90d-3a6d3c13fd3b',
version='6.0-preview.1',
route_values=route_values)
def query_all_streams(self):
"""QueryAllStreams.
[Preview API] Return all Audit Streams scoped to an organization
:rtype: [AuditStream]
"""
response = self._send(http_method='GET',
location_id='77d60bf9-1882-41c5-a90d-3a6d3c13fd3b',
version='6.0-preview.1')
return self._deserialize('[AuditStream]', self._unwrap_collection(response))
def query_stream_by_id(self, stream_id):
"""QueryStreamById.
[Preview API] Return Audit Stream with id of streamId if one exists otherwise throw
:param int stream_id: Id of stream entry to retrieve
:rtype: :class:`<AuditStream> <azure.devops.v6_0.audit.models.AuditStream>`
"""
route_values = {}
if stream_id is not None:
route_values['streamId'] = self._serialize.url('stream_id', stream_id, 'int')
response = self._send(http_method='GET',
location_id='77d60bf9-1882-41c5-a90d-3a6d3c13fd3b',
version='6.0-preview.1',
route_values=route_values)
return self._deserialize('AuditStream', response)
def update_status(self, stream_id, status):
"""UpdateStatus.
[Preview API] Update existing Audit Stream status
:param int stream_id: Id of stream entry to be updated
:param str status: Status of the stream
:rtype: :class:`<AuditStream> <azure.devops.v6_0.audit.models.AuditStream>`
"""
route_values = {}
if stream_id is not None:
route_values['streamId'] = self._serialize.url('stream_id', stream_id, 'int')
query_parameters = {}
if status is not None:
query_parameters['status'] = self._serialize.query('status', status, 'str')
response = self._send(http_method='PUT',
location_id='77d60bf9-1882-41c5-a90d-3a6d3c13fd3b',
version='6.0-preview.1',
route_values=route_values,
query_parameters=query_parameters)
return self._deserialize('AuditStream', response)
def update_stream(self, stream):
"""UpdateStream.
[Preview API] Update existing Audit Stream
:param :class:`<AuditStream> <azure.devops.v6_0.audit.models.AuditStream>` stream: Stream entry
:rtype: :class:`<AuditStream> <azure.devops.v6_0.audit.models.AuditStream>`
"""
content = self._serialize.body(stream, 'AuditStream')
response = self._send(http_method='PUT',
location_id='77d60bf9-1882-41c5-a90d-3a6d3c13fd3b',
version='6.0-preview.1',
content=content)
return self._deserialize('AuditStream', response)
|
