Skip to content

Commit 703aa82

Browse files
authored
[Identity] Update README regarding user-assigned MI (#37595)
Examples were added to demonstrate how to authenticate with a user-assigned managed identity using and object ID and resource ID. Signed-off-by: Paul Van Eck <[email protected]>
1 parent 5f5ab59 commit 703aa82

File tree

1 file changed

+30
-1
lines changed

1 file changed

+30
-1
lines changed

sdk/identity/azure-identity/README.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,13 +162,42 @@ client = SecretClient("https://my-vault.vault.azure.net", default_credential)
162162

163163
### Examples
164164

165+
These examples demonstrate authenticating `SecretClient` from the [`azure-keyvault-secrets`](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/keyvault/azure-keyvault-secrets) library with `ManagedIdentityCredential`.
166+
167+
165168
#### Authenticate with a user-assigned managed identity
166169

170+
To authenticate with a user-assigned managed identity, you must specify one of the following IDs for the managed identity.
171+
172+
##### Client ID
173+
174+
```python
175+
from azure.identity import ManagedIdentityCredential
176+
from azure.keyvault.secrets import SecretClient
177+
178+
credential = ManagedIdentityCredential(client_id="managed_identity_client_id")
179+
client = SecretClient("https://my-vault.vault.azure.net", credential)
180+
```
181+
182+
##### Resource ID
183+
184+
```python
185+
from azure.identity import ManagedIdentityCredential
186+
from azure.keyvault.secrets import SecretClient
187+
188+
resource_id = "/subscriptions/<id>/resourceGroups/<rg>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/<mi-name>"
189+
190+
credential = ManagedIdentityCredential(identity_config={"resource_id": resource_id})
191+
client = SecretClient("https://my-vault.vault.azure.net", credential)
192+
```
193+
194+
##### Object ID
195+
167196
```python
168197
from azure.identity import ManagedIdentityCredential
169198
from azure.keyvault.secrets import SecretClient
170199

171-
credential = ManagedIdentityCredential(client_id=managed_identity_client_id)
200+
credential = ManagedIdentityCredential(identity_config={"object_id": "managed_identity_object_id"})
172201
client = SecretClient("https://my-vault.vault.azure.net", credential)
173202
```
174203

0 commit comments

Comments
 (0)