OAuth2Permission Classe

Representa um âmbito de permissão delegada do OAuth 2.0. Os âmbitos de permissão delegados do OAuth 2.0 especificados podem ser pedidos pelas aplicações cliente (através da coleção requiredResourceAccess no objeto Aplicação) ao chamar uma aplicação de recurso. A propriedade oauth2Permissions da entidade ServicePrincipal e da entidade Aplicação é uma coleção de OAuth2Permission.

Herança
OAuth2Permission

Construtor

OAuth2Permission(*, admin_consent_description: str = None, admin_consent_display_name: str = None, id: str = None, is_enabled: bool = None, type: str = None, user_consent_description: str = None, user_consent_display_name: str = None, value: str = None, **kwargs)

Parâmetros

admin_consent_description
str
Necessário

Texto de ajuda de permissão que aparece nas experiências de consentimento do administrador e atribuição de aplicações.

admin_consent_display_name
str
Necessário

Nome a apresentar para a permissão que aparece nas experiências de consentimento do administrador e atribuição de aplicações.

id
str
Necessário

Identificador de permissão de âmbito exclusivo na coleção oauth2Permissions.

is_enabled
bool
Necessário

Ao criar ou atualizar uma permissão, esta propriedade tem de ser definida como verdadeira (que é a predefinição). Para eliminar uma permissão, esta propriedade tem primeiro de ser definida como falsa. Nessa altura, numa chamada subsequente, a permissão pode ser removida.

type
str
Necessário

Especifica se esta permissão de âmbito pode ser consentida por um utilizador final ou se é uma permissão ao nível do inquilino que tem de ser consentida por um Administrador da Empresa. Os valores possíveis são "Utilizador" ou "Administração".

user_consent_description
str
Necessário

Texto de ajuda de permissão que aparece na experiência de consentimento do utilizador final.

user_consent_display_name
str
Necessário

Nome a apresentar para a permissão que aparece na experiência de consentimento do utilizador final.

value
str
Necessário

O valor da afirmação de âmbito que a aplicação de recurso deve esperar no token de acesso OAuth 2.0.

Métodos

as_dict

Devolver um ditado que pode ser JSONify com json.dump.

Opcionalmente, a utilização avançada pode utilizar uma chamada de retorno como parâmetro:

A chave é o nome do atributo utilizado no Python. Attr_desc é um ditado dos metadados. Atualmente, contém "type" com o tipo msrest e "key" com a chave codificada RestAPI. O valor é o valor atual neste objeto.

A cadeia devolvida será utilizada para serializar a chave. Se o tipo de retorno for uma lista, isto é considerado dict de resultado hierárquico.

Veja os três exemplos neste ficheiro:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Se quiser serialização XML, pode transmitir os kwargs is_xml=True.

deserialize

Analise um str com a sintaxe RestAPI e devolva um modelo.

enable_additional_properties_sending
from_dict

Analisar um ditado com um determinado extrator de chaves devolve um modelo.

Por predefinição, considere extratores chave (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor e last_rest_key_case_insensitive_extractor)

is_xml_model
serialize

Devolver o JSON que seria enviado para o Azure a partir deste modelo.

Este é um alias para as_dict(full_restapi_key_transformer, keep_readonly=Falso).

Se quiser serialização XML, pode transmitir os kwargs is_xml=True.

validate

Valide este modelo de forma recursiva e devolva uma lista de ValidationError.

as_dict

Devolver um ditado que pode ser JSONify com json.dump.

Opcionalmente, a utilização avançada pode utilizar uma chamada de retorno como parâmetro:

A chave é o nome do atributo utilizado no Python. Attr_desc é um ditado dos metadados. Atualmente, contém "type" com o tipo msrest e "key" com a chave codificada RestAPI. O valor é o valor atual neste objeto.

A cadeia devolvida será utilizada para serializar a chave. Se o tipo de retorno for uma lista, isto é considerado dict de resultado hierárquico.

Veja os três exemplos neste ficheiro:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Se quiser serialização XML, pode transmitir os kwargs is_xml=True.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Parâmetros

key_transformer
<xref:function>

Uma função de transformador de chaves.

keep_readonly
valor predefinido: True

Devoluções

Um objeto compatível com JSON de ditado

Tipo de retorno

deserialize

Analise um str com a sintaxe RestAPI e devolva um modelo.

deserialize(data, content_type=None)

Parâmetros

data
str
Necessário

Um str com a estrutura RestAPI. JSON por predefinição.

content_type
str
valor predefinido: None

JSON por predefinição, defina application/xml se XML.

Devoluções

Uma instância deste modelo

Exceções

DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending()

from_dict

Analisar um ditado com um determinado extrator de chaves devolve um modelo.

Por predefinição, considere extratores chave (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor e last_rest_key_case_insensitive_extractor)

from_dict(data, key_extractors=None, content_type=None)

Parâmetros

data
dict
Necessário

Um ditado com a estrutura restAPI

content_type
str
valor predefinido: None

JSON por predefinição, defina application/xml se XML.

key_extractors
valor predefinido: None

Devoluções

Uma instância deste modelo

Exceções

DeserializationError if something went wrong

is_xml_model

is_xml_model()

serialize

Devolver o JSON que seria enviado para o Azure a partir deste modelo.

Este é um alias para as_dict(full_restapi_key_transformer, keep_readonly=Falso).

Se quiser serialização XML, pode transmitir os kwargs is_xml=True.

serialize(keep_readonly=False, **kwargs)

Parâmetros

keep_readonly
bool
valor predefinido: False

Se quiser serializar os atributos só de leitura

Devoluções

Um objeto compatível com JSON de ditado

Tipo de retorno

validate

Valide este modelo de forma recursiva e devolva uma lista de ValidationError.

validate()

Devoluções

Uma lista de erros de validação

Tipo de retorno