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
|
# ------------------------------------
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
# -------------------------------------
import asyncio
import pytest
from devtools_testutils import AzureRecordedTestCase, is_live
from devtools_testutils.aio import recorded_by_proxy_async
from _async_test_case import AsyncSecretsClientPreparer
from _shared.test_case_async import KeyVaultTestCase
from _test_case import get_decorator
all_api_versions = get_decorator()
def print(*args):
assert all(arg is not None for arg in args)
@pytest.mark.asyncio
@pytest.mark.playback_test_only("Can't run in live pipelines, and there's no reason to.")
async def test_create_secret_client():
vault_url = "vault_url"
# pylint:disable=unused-variable
# [START create_secret_client]
from azure.identity.aio import DefaultAzureCredential
from azure.keyvault.secrets.aio import SecretClient
# Create a SecretClient using default Azure credentials
credential = DefaultAzureCredential()
secret_client = SecretClient(vault_url, credential)
# the client and credential should be closed when no longer needed
# (both are also async context managers)
await secret_client.close()
await credential.close()
# [END create_secret_client]
class TestExamplesKeyVault(KeyVaultTestCase):
@AzureRecordedTestCase.await_prepared_test
@pytest.mark.parametrize("api_version", all_api_versions, ids=all_api_versions)
@AsyncSecretsClientPreparer()
@recorded_by_proxy_async
async def test_example_secret_crud_operations(self, client, **kwargs):
secret_client = client
secret_name = self.get_resource_name("secret-name")
# [START set_secret]
from dateutil import parser as date_parse
expires_on = date_parse.parse("2050-02-02T08:00:00.000Z")
async with secret_client:
# create a secret, setting optional arguments
secret = await secret_client.set_secret(secret_name, "secret-value", enabled=True, expires_on=expires_on)
print(secret.id)
print(secret.name)
print(secret.properties.enabled)
print(secret.properties.expires_on)
# [END set_secret]
secret_version = secret.properties.version
# [START get_secret]
# get the latest version of a secret
secret = await secret_client.get_secret(secret_name)
# alternatively, specify a version
secret = await secret_client.get_secret(secret_name, secret_version)
print(secret.id)
print(secret.name)
print(secret.properties.version)
print(secret.properties.vault_url)
# [END get_secret]
# [START update_secret]
# update attributes of an existing secret
content_type = "text/plain"
tags = {"foo": "updated tag"}
updated_secret_properties = await secret_client.update_secret_properties(
secret_name, content_type=content_type, tags=tags
)
print(updated_secret_properties.version)
print(updated_secret_properties.updated_on)
print(updated_secret_properties.content_type)
print(updated_secret_properties.tags)
# [END update_secret]
# [START delete_secret]
# delete a secret
deleted_secret = await secret_client.delete_secret(secret_name)
print(deleted_secret.name)
# if the vault has soft-delete enabled, the secret's deleted_date,
# scheduled purge date and recovery id are set
print(deleted_secret.deleted_date)
print(deleted_secret.scheduled_purge_date)
print(deleted_secret.recovery_id)
# [END delete_secret]
@AzureRecordedTestCase.await_prepared_test
@pytest.mark.parametrize("api_version", all_api_versions, ids=all_api_versions)
@AsyncSecretsClientPreparer()
@recorded_by_proxy_async
async def test_example_secret_list_operations(self, client, **kwargs):
secret_client = client
async with secret_client:
for i in range(7):
secret_name = self.get_resource_name(f"secret{i}")
await secret_client.set_secret(secret_name, f"value{i}")
# [START list_secrets]
# gets a list of secrets in the vault
secrets = secret_client.list_properties_of_secrets()
async for secret in secrets:
# the list doesn't include values or versions of the secrets
print(secret.id)
print(secret.name)
print(secret.enabled)
# [END list_secrets]
# [START list_properties_of_secret_versions]
# gets a list of all versions of a secret
secret_versions = secret_client.list_properties_of_secret_versions("secret-name")
async for secret in secret_versions:
# the list doesn't include the versions' values
print(secret.id)
print(secret.enabled)
print(secret.updated_on)
# [END list_properties_of_secret_versions]
# [START list_deleted_secrets]
# gets a list of deleted secrets (requires soft-delete enabled for the vault)
deleted_secrets = secret_client.list_deleted_secrets()
async for secret in deleted_secrets:
# the list doesn't include values or versions of the deleted secrets
print(secret.id)
print(secret.name)
print(secret.scheduled_purge_date)
print(secret.recovery_id)
print(secret.deleted_date)
# [END list_deleted_secrets]
@AzureRecordedTestCase.await_prepared_test
@pytest.mark.parametrize("api_version", all_api_versions, ids=all_api_versions)
@AsyncSecretsClientPreparer()
@recorded_by_proxy_async
async def test_example_secrets_backup_restore(self, client, **kwargs):
secret_client = client
secret_name = self.get_resource_name("secret-name")
async with secret_client:
await secret_client.set_secret(secret_name, "secret-value")
# [START backup_secret]
# backup secret
secret_backup = await secret_client.backup_secret(secret_name)
# returns the raw bytes of the backed up secret
print(secret_backup)
# [END backup_secret]
await secret_client.delete_secret(secret_name)
await secret_client.purge_deleted_secret(secret_name)
if self.is_live:
await asyncio.sleep(60)
# [START restore_secret_backup]
# restores a backed up secret
restored_secret = await secret_client.restore_secret_backup(secret_backup)
print(restored_secret.id)
print(restored_secret.version)
# [END restore_secret_backup]
@AzureRecordedTestCase.await_prepared_test
@pytest.mark.parametrize("api_version", all_api_versions, ids=all_api_versions)
@AsyncSecretsClientPreparer()
@recorded_by_proxy_async
async def test_example_secrets_recover(self, client, **kwargs):
secret_client = client
secret_name = self.get_resource_name("secret-name")
async with client:
await secret_client.set_secret(secret_name, "secret-value")
await secret_client.delete_secret(secret_name)
# [START get_deleted_secret]
# gets a deleted secret (requires soft-delete enabled for the vault)
deleted_secret = await secret_client.get_deleted_secret(secret_name)
print(deleted_secret.name)
# [END get_deleted_secret]
# [START recover_deleted_secret]
# recover deleted secret to the latest version
recovered_secret = await secret_client.recover_deleted_secret(secret_name)
print(recovered_secret.id)
print(recovered_secret.name)
# [END recover_deleted_secret]
|
