File: credential_creation_code_snippets.py

package info (click to toggle)
python-azure 20250603%2Bgit-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 851,724 kB
  • sloc: python: 7,362,925; ansic: 804; javascript: 287; makefile: 195; sh: 145; xml: 109
file content (379 lines) | stat: -rw-r--r-- 11,818 bytes parent folder | download
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
# ------------------------------------
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
# ------------------------------------
"""Code snippets demonstrating how to create various credentials."""


def create_authorization_code_credential():
    # [START create_authorization_code_credential]
    from azure.identity import AuthorizationCodeCredential

    credential = AuthorizationCodeCredential(
        tenant_id="<tenant_id>",
        client_id="<client_id>",
        authorization_code="<auth_code>",
        redirect_uri="<redirect_uri>",
    )
    # [END create_authorization_code_credential]


async def create_authorization_code_credential_async():
    # [START create_authorization_code_credential_async]
    from azure.identity.aio import AuthorizationCodeCredential

    credential = AuthorizationCodeCredential(
        tenant_id="<tenant_id>",
        client_id="<client_id>",
        authorization_code="<auth_code>",
        redirect_uri="<redirect_uri>",
    )
    # [END create_authorization_code_credential_async]


def create_azure_cli_credential():
    # [START create_azure_cli_credential]
    from azure.identity import AzureCliCredential

    credential = AzureCliCredential()
    # [END create_azure_cli_credential]


async def create_azure_cli_credential_async():
    # [START create_azure_cli_credential_async]
    from azure.identity.aio import AzureCliCredential

    credential = AzureCliCredential()
    # [END create_azure_cli_credential_async]


def create_azure_developer_cli_credential():
    # [START azure_developer_cli_credential]
    from azure.identity import AzureDeveloperCliCredential

    credential = AzureDeveloperCliCredential()
    # [END azure_developer_cli_credential]


async def create_azure_developer_cli_credential_async():
    # [START azure_developer_cli_credential_async]
    from azure.identity.aio import AzureDeveloperCliCredential

    credential = AzureDeveloperCliCredential()
    # [END azure_developer_cli_credential_async]


def create_azure_power_shell_credential():
    # [START create_azure_power_shell_credential]
    from azure.identity import AzurePowerShellCredential

    credential = AzurePowerShellCredential()
    # [END create_azure_power_shell_credential]


async def create_azure_power_shell_credential_async():
    # [START create_azure_power_shell_credential_async]
    from azure.identity.aio import AzurePowerShellCredential

    credential = AzurePowerShellCredential()
    # [END create_azure_power_shell_credential_async]


def create_certificate_credential():
    # [START create_certificate_credential]
    from azure.identity import CertificateCredential

    credential = CertificateCredential(
        tenant_id="<tenant_id>",
        client_id="<client_id>",
        certificate_path="<path to PEM/PKCS12 certificate>",
        password="<certificate password if necessary>",
    )

    # Certificate/private key byte data can also be passed directly
    credential = CertificateCredential(
        tenant_id="<tenant_id>",
        client_id="<client_id>",
        certificate_data=b"<cert data>",
    )
    # [END create_certificate_credential]


async def create_certificate_credential_async():
    # [START create_certificate_credential_async]
    from azure.identity.aio import CertificateCredential

    credential = CertificateCredential(
        tenant_id="<tenant_id>",
        client_id="<client_id>",
        certificate_path="<path to PEM/PKCS12 certificate>",
        password="<certificate password if necessary>",
    )

    # Certificate/private key byte data can also be passed directly
    credential = CertificateCredential(
        tenant_id="<tenant_id>",
        client_id="<client_id>",
        certificate_data=b"<cert data>",
    )
    # [END create_certificate_credential_async]


def create_chained_token_credential():
    # [START create_chained_token_credential]
    from azure.identity import ChainedTokenCredential, EnvironmentCredential, AzureCliCredential

    credential_chain = (
        # Try EnvironmentCredential first
        EnvironmentCredential(),
        # Fallback to Azure CLI if EnvironmentCredential fails
        AzureCliCredential(),
    )
    credential = ChainedTokenCredential(*credential_chain)
    # [END create_chained_token_credential]


async def create_chained_token_credential_async():
    # [START create_chained_token_credential_async]
    from azure.identity.aio import ChainedTokenCredential, EnvironmentCredential, AzureCliCredential

    credential_chain = (
        # Try EnvironmentCredential first
        EnvironmentCredential(),
        # Fallback to Azure CLI if EnvironmentCredential fails
        AzureCliCredential(),
    )
    credential = ChainedTokenCredential(*credential_chain)
    # [END create_chained_token_credential_async]


def create_client_assertion_credential():
    # [START create_client_assertion_credential]
    from azure.identity import ClientAssertionCredential

    def get_assertion():
        return "<client-assertion>"

    credential = ClientAssertionCredential(
        tenant_id="<tenant_id>",
        client_id="<client_id>",
        func=get_assertion,
    )
    # [END create_client_assertion_credential]


async def create_client_assertion_credential_async():
    # [START create_client_assertion_credential_async]
    from azure.identity.aio import ClientAssertionCredential

    def get_assertion():
        return "<client-assertion>"

    credential = ClientAssertionCredential(
        tenant_id="<tenant_id>",
        client_id="<client_id>",
        func=get_assertion,
    )
    # [END create_client_assertion_credential_async]


def create_client_secret_credential():
    # [START create_client_secret_credential]
    from azure.identity import ClientSecretCredential

    credential = ClientSecretCredential(
        tenant_id="<tenant_id>",
        client_id="<client_id>",
        client_secret="<client_secret>",
    )
    # [END create_client_secret_credential]


async def create_client_secret_credential_async():
    # [START create_client_secret_credential_async]
    from azure.identity.aio import ClientSecretCredential

    credential = ClientSecretCredential(
        tenant_id="<tenant_id>",
        client_id="<client_id>",
        client_secret="<client_secret>",
    )
    # [END create_client_secret_credential_async]


def create_default_credential():
    # [START create_default_credential]
    from azure.identity import DefaultAzureCredential

    credential = DefaultAzureCredential()
    # [END create_default_credential]


async def create_default_credential_async():
    # [START create_default_credential_async]
    from azure.identity.aio import DefaultAzureCredential

    credential = DefaultAzureCredential()
    # [END create_default_credential_async]


def create_device_code_credential():
    # [START create_device_code_credential]
    from azure.identity import DeviceCodeCredential

    credential = DeviceCodeCredential()
    # [END create_device_code_credential]


def create_environment_credential():
    # [START create_environment_credential]
    from azure.identity import EnvironmentCredential

    credential = EnvironmentCredential()
    # [END create_environment_credential]


async def create_environment_credential_async():
    # [START create_environment_credential_async]
    from azure.identity.aio import EnvironmentCredential

    credential = EnvironmentCredential()
    # [END create_environment_credential_async]


def create_interactive_browser_credential():
    # [START create_interactive_browser_credential]
    from azure.identity import InteractiveBrowserCredential

    credential = InteractiveBrowserCredential(
        client_id="<client_id>",
    )
    # [END create_interactive_browser_credential]


def create_managed_identity_credential():
    # [START create_managed_identity_credential]
    from azure.identity import ManagedIdentityCredential

    credential = ManagedIdentityCredential()

    # Can also specify a client ID of a user-assigned managed identity
    credential = ManagedIdentityCredential(
        client_id="<client_id>",
    )
    # [END create_managed_identity_credential]


async def create_managed_identity_credential_async():
    # [START create_managed_identity_credential_async]
    from azure.identity.aio import ManagedIdentityCredential

    credential = ManagedIdentityCredential()

    # Can also specify a client ID of a user-assigned managed identity
    credential = ManagedIdentityCredential(
        client_id="<client_id>",
    )
    # [END create_managed_identity_credential_async]


def create_on_behalf_of_credential():
    # [START create_on_behalf_of_credential]
    from azure.identity import OnBehalfOfCredential

    credential = OnBehalfOfCredential(
        tenant_id="<tenant_id>",
        client_id="<client_id>",
        client_secret="<client_secret>",
        user_assertion="<access_token>",
    )
    # [END create_on_behalf_of_credential]


async def create_on_behalf_of_credential_async():
    # [START create_on_behalf_of_credential_async]
    from azure.identity.aio import OnBehalfOfCredential

    credential = OnBehalfOfCredential(
        tenant_id="<tenant_id>",
        client_id="<client_id>",
        client_secret="<client_secret>",
        user_assertion="<access_token>",
    )
    # [END create_on_behalf_of_credential_async]


def create_username_password_credential():
    # [START create_username_password_credential]
    from azure.identity import UsernamePasswordCredential

    credential = UsernamePasswordCredential(
        client_id="<client_id>",
        username="<username>",
        password="<password>",
    )
    # [END create_username_password_credential]


def create_workload_identity_credential():
    # [START workload_identity_credential]
    from azure.identity import WorkloadIdentityCredential

    credential = WorkloadIdentityCredential(
        tenant_id="<tenant_id>",
        client_id="<client_id>",
        token_file_path="<token_file_path>",
    )

    # Parameters can be omitted if the following environment variables are set:
    #   - AZURE_TENANT_ID
    #   - AZURE_CLIENT_ID
    #   - AZURE_FEDERATED_TOKEN_FILE
    credential = WorkloadIdentityCredential()
    # [END workload_identity_credential]


async def create_workload_identity_credential_async():
    # [START workload_identity_credential_async]
    from azure.identity.aio import WorkloadIdentityCredential

    credential = WorkloadIdentityCredential(
        tenant_id="<tenant_id>",
        client_id="<client_id>",
        token_file_path="<token_file_path>",
    )

    # Parameters can be omitted if the following environment variables are set:
    #   - AZURE_TENANT_ID
    #   - AZURE_CLIENT_ID
    #   - AZURE_FEDERATED_TOKEN_FILE
    credential = WorkloadIdentityCredential()
    # [END workload_identity_credential_async]


def create_azure_pipelines_credential():
    # [START create_azure_pipelines_credential]
    import os
    from azure.identity import AzurePipelinesCredential

    credential = AzurePipelinesCredential(
        system_access_token=os.environ["SYSTEM_ACCESSTOKEN"],
        tenant_id="<tenant_id>",
        client_id="<client_id>",
        service_connection_id="<service_connection_id>",
    )
    # [END create_azure_pipelines_credential]


async def create_azure_pipelines_credential_async():
    # [START create_azure_pipelines_credential_async]
    import os
    from azure.identity.aio import AzurePipelinesCredential

    credential = AzurePipelinesCredential(
        system_access_token=os.environ["SYSTEM_ACCESSTOKEN"],
        tenant_id="<tenant_id>",
        client_id="<client_id>",
        service_connection_id="<service_connection_id>",
    )
    # [END create_azure_pipelines_credential_async]