Skip to content

[Key Vault] Revise administration models #19049

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
laiapat wants to merge 2 commits into from
Closed

[Key Vault] Revise administration models #19049

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5474eab
Model properties
laiapat May 6, 2021
db27f4d
Use ODataV4Format
laiapat Jun 2, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
147 changes: 98 additions & 49 deletions sdk/keyvault/azure-keyvault-administration/azure/keyvault/administration/_models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,13 @@
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
# ------------------------------------
from datetime import datetime
from typing import TYPE_CHECKING

from azure.core.exceptions import ODataV4Format

if TYPE_CHECKING:
from typing import Any
from typing import Any, Optional


# pylint:disable=protected-access
Expand All @@ -14,20 +17,46 @@
class KeyVaultPermission(object):
"""Role definition permissions.

:ivar list[str] actions: Action permissions that are granted.
:ivar list[str] not_actions: Action permissions that are excluded but not denied. They may be granted by other role
definitions assigned to a principal.
:ivar list[str] data_actions: Data action permissions that are granted.
:ivar list[str] not_data_actions: Data action permissions that are excluded but not denied. They may be granted by
other role definitions assigned to a principal.
:keyword list[str] actions: Action permissions that are granted.
:keyword list[str] not_actions: Action permissions that are excluded but not denied. They may be granted by other
role definitions assigned to a principal.
:keyword list[str] data_actions: Data action permissions that are granted.
:keyword list[str] not_data_actions: Data action permissions that are excluded but not denied. They may be granted
by other role definitions assigned to a principal.
"""

def __init__(self, **kwargs):
# type: (**Any) -> None
self.actions = kwargs.get("actions")
self.not_actions = kwargs.get("not_actions")
self.data_actions = kwargs.get("data_actions")
self.not_data_actions = kwargs.get("not_data_actions")
self._actions = kwargs.get("actions", [])
self._not_actions = kwargs.get("not_actions", [])
self._data_actions = kwargs.get("data_actions", [])
self._not_data_actions = kwargs.get("not_data_actions", [])

@property
def actions(self):
# type: () -> list[str]
"""Actions permissions that are granted"""
return self._actions

@property
def not_actions(self):
# type: () -> list[str]
"""Action permissions that are excluded but not denied. They may be granted by other role definitions assigned
to a principal"""
return self._not_actions

@property
def data_actions(self):
# type: () -> list[str]
"""Data action permissions that are granted"""
return self._data_actions

@property
def not_data_actions(self):
# type: () -> list[str]
"""Data action permissions that are excluded but not denied. They may be granted by other role definitions
assigned to a principal"""
return self._not_data_actions

@classmethod
def _from_generated(cls, permissions):
Expand Down Expand Up @@ -216,57 +245,77 @@ def _from_generated(cls, definition):

class _Operation(object):
def __init__(self, **kwargs):
self.status = kwargs.get("status", None)
self.status_details = kwargs.get("status_details", None)
self.error = kwargs.get("error", None)
self.start_time = kwargs.get("start_time", None)
self.end_time = kwargs.get("end_time", None)
self.job_id = kwargs.get("job_id", None)
self._status = kwargs.get("status", None)
self._status_details = kwargs.get("status_details", None)
self._start_time = kwargs.get("start_time", None)
self._end_time = kwargs.get("end_time", None)
self._job_id = kwargs.get("job_id", None)

error = kwargs.get("error", None)
# responses can return an empty error object when there's no error
if error is None or error.code is None:
self._error = None
else:
self._error = ODataV4Format(vars(error))

@laiapat laiapat Jun 3, 2021

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small but important detail here: ODataV4Format expects the inner error to be labeled as innererror, but the error we get back labels it as inner_error and doesn't get applied to the resulting ODataV4Format object. Does it make sense to edit the label to be innererror, or would that be forcing a square peg into a round hole?

@chlowell chlowell Jun 3, 2021

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ODataV4Format expects JSON deserialized to a dict but the Error class generated by autorest has already deserialized the JSON and Pythonified "innererror" to "inner_error". What do you get from error.as_dict()? Also, ODataV4Format.innererror should be a JSON dict as well--it's JSON dicts all the way down.

@laiapat laiapat Jun 3, 2021

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

error.as_dict() gives the same dictionary as vars(dict) -- we're still left with an inner_error key 😕

@chlowell chlowell Jun 3, 2021

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you use the key_transformer argument to rename it?

@laiapat laiapat Jun 3, 2021

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay nice, that does work with something like:

def my_key_transformer(key, attr_desc, value):
    if key == "inner_error":
        return ("innererror", value)
    return (key, value)

for errors with no inner error (error.inner_error = None) and errors with JSON dict inner errors (they get recursively renamed)

@laiapat laiapat Jun 3, 2021

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like something like this would work as well:

error.as_dict(key_transformer=lambda k, _, v: ("innererror", v) if k == "inner_error" else (k, v))


@property
def status(self):
# type: () -> Optional[str]
"""Status of the operation"""
return self._status

@property
def status_details(self):
# type: () -> Optional[str]
"""More details of the operation's status"""
return self._status_details

@property
def error(self):
# type: () -> Optional[ODataV4Format]
"""Error encountered, if any, during the operation"""
return self._error

@property
def start_time(self):
# type: () -> Optional[datetime.datetime]
"""UTC start time of the operation"""
return self._start_time

@property
def end_time(self):
# type: () -> Optional[datetime.datetime]
"""UTC end time of the operation"""
return self._end_time

@property
def job_id(self):
# type: () -> Optional[str]
"""Identifier for the operation"""
return self._job_id

@classmethod
def _wrap_generated(cls, response, deserialized_operation, response_headers): # pylint:disable=unused-argument
return cls(**deserialized_operation.__dict__)


class KeyVaultBackupOperation(_Operation):
"""A Key Vault full backup operation.

:ivar str status: status of the backup operation
:ivar str status_details: more details of the operation's status
:ivar error: Error encountered, if any, during the operation
:type error: ~key_vault_client.models.Error
:ivar datetime.datetime start_time: UTC start time of the operation
:ivar datetime.datetime end_time: UTC end time of the operation
:ivar str job_id: identifier for the operation
:ivar str folder_url: URL of the Azure blob storage container which contains the backup
"""
"""A Key Vault full backup operation."""

def __init__(self, **kwargs):
self.folder_url = kwargs.pop("azure_storage_blob_container_uri", None)
self._folder_url = kwargs.pop("azure_storage_blob_container_uri", None)
super(KeyVaultBackupOperation, self).__init__(**kwargs)

@property
def folder_url(self):
# type: () -> str
"""URL of the Azure blob storage container which contains the backup"""
return self._folder_url


class KeyVaultRestoreOperation(_Operation):
"""A Key Vault restore operation.

:ivar str status: status of the operation
:ivar str status_details: more details of the operation's status
:ivar error: Error encountered, if any, during the operation
:type error: ~key_vault_client.models.Error
:ivar datetime.datetime start_time: UTC start time of the operation
:ivar datetime.datetime end_time: UTC end time of the operation
:ivar str job_id: identifier for the operation
"""
"""A Key Vault restore operation."""


class KeyVaultSelectiveKeyRestoreOperation(_Operation):
"""A Key Vault operation restoring a single key.

:ivar str status: status of the operation
:ivar str status_details: more details of the operation's status
:ivar error: Error encountered, if any, during the operation
:type error: ~key_vault_client.models.Error
:ivar datetime.datetime start_time: UTC start time of the operation
:ivar datetime.datetime end_time: UTC end time of the operation
:ivar str job_id: identifier for the operation
"""
"""A Key Vault operation restoring a single key."""