document the form of role_scope

Azure · Aug 28, 2020 · 79ee5de · 79ee5de
1 parent f675ce7
commit 79ee5de
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/...ult/azure-keyvault-administration/azure/keyvault/administration/_access_control_client.py b/...ult/azure-keyvault-administration/azure/keyvault/administration/_access_control_client.py
@@ -57,7 +57,7 @@ def delete_role_assignment(self, role_scope, role_assignment_name, **kwargs):
         # type: (str, Union[str, UUID], **Any) -> KeyVaultRoleAssignment
         """Delete a role assignment.
 
-        :param str role_scope: the assignment's scope
+        :param str role_scope: the assignment's scope, for example "/", "/keys", or "/keys/<specific key identifier>"
         :param role_assignment_name: the assignment's name. Must be a UUID.
         :type role_assignment_name: str or uuid.UUID
         :returns: the deleted assignment
@@ -73,7 +73,7 @@ def get_role_assignment(self, role_scope, role_assignment_name, **kwargs):
         # type: (str, Union[str, UUID], **Any) -> KeyVaultRoleAssignment
         """Get a role assignment.
 
-        :param str role_scope: the assignment's scope
+        :param str role_scope: the assignment's scope, for example "/", "/keys", or "/keys/<specific key identifier>"
         :param role_assignment_name: the assignment's name. Must be a UUID.
         :type role_assignment_name: str or uuid.UUID
         :rtype: KeyVaultRoleAssignment

diff --git a/...azure-keyvault-administration/azure/keyvault/administration/aio/_access_control_client.py b/...azure-keyvault-administration/azure/keyvault/administration/aio/_access_control_client.py
@@ -65,7 +65,7 @@ async def delete_role_assignment(
     ) -> KeyVaultRoleAssignment:
         """Delete a role assignment.
 
-        :param str role_scope: the assignment's scope
+        :param str role_scope: the assignment's scope, for example "/", "/keys", or "/keys/<specific key identifier>"
         :param role_assignment_name: the assignment's name. Must be a UUID.
         :type role_assignment_name: str or uuid.UUID
         :returns: the deleted assignment
@@ -82,7 +82,7 @@ async def get_role_assignment(
     ) -> KeyVaultRoleAssignment:
         """Get a role assignment.
 
-        :param str role_scope: the assignment's scope
+        :param str role_scope: the assignment's scope, for example "/", "/keys", or "/keys/<specific key identifier>"
         :param role_assignment_name: the assignment's name. Must be a UUID.
         :type role_assignment_name: str or uuid.UUID
         :rtype: KeyVaultRoleAssignment