add parse_certificate_id

Author: iscai-msft

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

@@ -2,6 +2,10 @@
 
 ## 4.2.1 (Unreleased)
 
+### Added
+- Added method `parse_certificate_id` that parses out a full ID returned by key vault, so users
+can easily access the certificate's `name`, `vault_url`, `version` etc.
+
 
 ## 4.2.0 (2020-08-11)
 ### Fixed

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

@@ -0,0 +1,33 @@
+# ------------------------------------
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+# ------------------------------------
+
+from ._shared import parse_key_vault_identifier, ParsedId
+
+
+def parse_certificate_id(original_id):
+    # type: (str) -> ParsedId
+    """Parses a full certificate's ID into a class.
+
+    :param str original_id: the full original identifier of a certificate
+    :returns: Returns a parsed certificate id
+    :rtype: ~azure.keyvault.certificates.ParsedId
+    :raises: ValueError
+    """
+    parsed_id = parse_key_vault_identifier(original_id)
+
+    valid_collections = ["certificates", "deletedcertificates"]
+
+    if parsed_id.collection not in valid_collections:
+        raise ValueError(
+            "Collection '{}' is not a valid certificate collection. ".format(parsed_id.collection),
+            "Valid collections are: {}".format(", ".join(valid_collections))
+        )
+    return ParsedId(
+        collection=parsed_id.collection,
+        name=parsed_id.name,
+        original_id=parsed_id.original_id,
+        vault_url=parsed_id.vault_url,
+        version=parsed_id.version
+    )