Skip to content

Commit 79ee5de

Browse files
committed
document the form of role_scope
1 parent f675ce7 commit 79ee5de

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

sdk/keyvault/azure-keyvault-administration/azure/keyvault/administration/_access_control_client.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ def delete_role_assignment(self, role_scope, role_assignment_name, **kwargs):
5757
# type: (str, Union[str, UUID], **Any) -> KeyVaultRoleAssignment
5858
"""Delete a role assignment.
5959
60-
:param str role_scope: the assignment's scope
60+
:param str role_scope: the assignment's scope, for example "/", "/keys", or "/keys/<specific key identifier>"
6161
:param role_assignment_name: the assignment's name. Must be a UUID.
6262
:type role_assignment_name: str or uuid.UUID
6363
:returns: the deleted assignment
@@ -73,7 +73,7 @@ def get_role_assignment(self, role_scope, role_assignment_name, **kwargs):
7373
# type: (str, Union[str, UUID], **Any) -> KeyVaultRoleAssignment
7474
"""Get a role assignment.
7575
76-
:param str role_scope: the assignment's scope
76+
:param str role_scope: the assignment's scope, for example "/", "/keys", or "/keys/<specific key identifier>"
7777
:param role_assignment_name: the assignment's name. Must be a UUID.
7878
:type role_assignment_name: str or uuid.UUID
7979
:rtype: KeyVaultRoleAssignment

sdk/keyvault/azure-keyvault-administration/azure/keyvault/administration/aio/_access_control_client.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ async def delete_role_assignment(
6565
) -> KeyVaultRoleAssignment:
6666
"""Delete a role assignment.
6767
68-
:param str role_scope: the assignment's scope
68+
:param str role_scope: the assignment's scope, for example "/", "/keys", or "/keys/<specific key identifier>"
6969
:param role_assignment_name: the assignment's name. Must be a UUID.
7070
:type role_assignment_name: str or uuid.UUID
7171
:returns: the deleted assignment
@@ -82,7 +82,7 @@ async def get_role_assignment(
8282
) -> KeyVaultRoleAssignment:
8383
"""Get a role assignment.
8484
85-
:param str role_scope: the assignment's scope
85+
:param str role_scope: the assignment's scope, for example "/", "/keys", or "/keys/<specific key identifier>"
8686
:param role_assignment_name: the assignment's name. Must be a UUID.
8787
:type role_assignment_name: str or uuid.UUID
8888
:rtype: KeyVaultRoleAssignment

0 commit comments

Comments
 (0)