[Key Vault] Align secrets with other languages (Azure#18766)

Author: mccoyp

sdk/keyvault/azure-keyvault-secrets/CHANGELOG.md

@@ -4,9 +4,13 @@
 ### Fixed
 - Correct typing for async paging methods
 
+### Changed
+- Key Vault API version 7.2 is now the default
+- Updated minimum `msrest` version to 0.6.21
+
 ### Added
-- Added method `parse_key_vault_secret_id` that parses out a full ID returned by Key Vault, so users can easily
-access the secret's `name`, `vault_url`, and `version`.
+- Added class `KeyVaultSecretIdentifier` that parses out a full ID returned by Key Vault,
+  so users can easily access the secret's `name`, `vault_url`, and `version`.
 
 ## 4.2.0 (2020-08-11)
 ### Fixed

sdk/keyvault/azure-keyvault-secrets/azure/keyvault/secrets/__init__.py

@@ -2,20 +2,17 @@
 # Copyright (c) Microsoft Corporation.
 # Licensed under the MIT License.
 # ------------------------------------
-from ._models import DeletedSecret, KeyVaultSecret, SecretProperties
-from ._parse_id import parse_key_vault_secret_id
-from ._shared import KeyVaultResourceId
+from ._models import DeletedSecret, KeyVaultSecret, KeyVaultSecretIdentifier, SecretProperties
 from ._shared.client_base import ApiVersion
 from ._client import SecretClient
 
 __all__ = [
     "ApiVersion",
     "SecretClient",
     "KeyVaultSecret",
+    "KeyVaultSecretIdentifier",
     "SecretProperties",
-    "DeletedSecret",
-    "parse_key_vault_secret_id",
-    "KeyVaultResourceId"
+    "DeletedSecret"
 ]
 
 from ._version import VERSION

sdk/keyvault/azure-keyvault-secrets/azure/keyvault/secrets/_models.py

@@ -23,7 +23,7 @@ def __init__(self, attributes, vault_id, **kwargs):
         # type: (_models.SecretAttributes, str, **Any) -> None
         self._attributes = attributes
         self._id = vault_id
-        self._vault_id = parse_key_vault_id(vault_id)
+        self._vault_id = KeyVaultSecretIdentifier(vault_id)
         self._content_type = kwargs.get("content_type", None)
         self._key_id = kwargs.get("key_id", None)
         self._managed = kwargs.get("managed", None)
@@ -245,6 +245,45 @@ def value(self):
         return self._value
 
 
+class KeyVaultSecretIdentifier(object):
+    """Information about a KeyVaultSecret parsed from a secret ID.
+
+    :param str id: the full original identifier of a secret
+    :raises ValueError: if the secret ID is improperly formatted
+    Example:
+        .. literalinclude:: ../tests/test_parse_id.py
+            :start-after: [START parse_key_vault_secret_id]
+            :end-before: [END parse_key_vault_secret_id]
+            :language: python
+            :caption: Parse a secret's ID
+            :dedent: 8
+    """
+
+    def __init__(self, id):  # pylint: disable=W0622
+        # type: (str) -> None
+        self._resource_id = parse_key_vault_id(id)
+
+    @property
+    def source_id(self):
+        # type: () -> str
+        return self._resource_id.source_id
+
+    @property
+    def vault_url(self):
+        # type: () -> str
+        return self._resource_id.vault_url
+
+    @property
+    def name(self):
+        # type: () -> str
+        return self._resource_id.name
+
+    @property
+    def version(self):
+        # type: () -> Optional[str]
+        return self._resource_id.version
+
+
 class DeletedSecret(object):
     """A deleted secret's properties and information about its deletion. If soft-delete
     is enabled, returns information about its recovery as well."""

sdk/keyvault/azure-keyvault-secrets/azure/keyvault/secrets/_parse_id.py

@@ -2,7 +2,7 @@
 # Copyright (c) Microsoft Corporation.
 # Licensed under the MIT License.
 # -------------------------------------
-from azure.keyvault.secrets import parse_key_vault_secret_id
+from azure.keyvault.secrets import KeyVaultSecretIdentifier
 from devtools_testutils import PowerShellPreparer
 
 from _shared.test_case import KeyVaultTestCase
@@ -21,7 +21,7 @@ def test_parse_secret_id_with_version(self, azure_keyvault_url):
 
         # [START parse_key_vault_secret_id]
         secret = client.get_secret(secret_name)
-        parsed_secret_id = parse_key_vault_secret_id(secret.id)
+        parsed_secret_id = KeyVaultSecretIdentifier(secret.id)
 
         print(parsed_secret_id.name)
         print(parsed_secret_id.vault_url)
@@ -36,7 +36,7 @@ def test_parse_secret_id_with_version(self, azure_keyvault_url):
 
 def test_parse_secret_id_with_pending_version():
     source_id = "https://keyvault-name.vault.azure.net/secrets/secret-name/pending"
-    parsed_secret_id = parse_key_vault_secret_id(source_id)
+    parsed_secret_id = KeyVaultSecretIdentifier(source_id)
 
     assert parsed_secret_id.name == "secret-name"
     assert parsed_secret_id.vault_url == "https://keyvault-name.vault.azure.net"
@@ -46,7 +46,7 @@ def test_parse_secret_id_with_pending_version():
 
 def test_parse_deleted_secret_id():
     source_id = "https://keyvault-name.vault.azure.net/deletedsecrets/deleted-secret"
-    parsed_secret_id = parse_key_vault_secret_id(source_id)
+    parsed_secret_id = KeyVaultSecretIdentifier(source_id)
 
     assert parsed_secret_id.name == "deleted-secret"
     assert parsed_secret_id.vault_url == "https://keyvault-name.vault.azure.net"