PolicyDefinitionsOperations Classe

Aviso

NÃO instancie essa classe diretamente.

Em vez disso, você deve acessar as operações a seguir por meio de

PolicyClient's

Atributo <xref:policy_definitions>.

Herança

builtins.object

PolicyDefinitionsOperations

Construtor

PolicyDefinitionsOperations(*args, **kwargs)

Métodos

create_or_update	Cria ou atualiza uma definição de política em uma assinatura. Essa operação cria ou atualiza uma definição de política na assinatura fornecida com o nome fornecido.
create_or_update_at_management_group	Cria ou atualiza uma definição de política em um grupo de gerenciamento. Essa operação cria ou atualiza uma definição de política no grupo de gerenciamento fornecido com o nome fornecido.
delete	Exclui uma definição de política em uma assinatura. Essa operação exclui a definição de política na assinatura fornecida com o nome fornecido.
delete_at_management_group	Exclui uma definição de política em um grupo de gerenciamento. Essa operação exclui a definição de política no grupo de gerenciamento fornecido com o nome fornecido.
get	Recupera uma definição de política em uma assinatura. Essa operação recupera a definição de política na assinatura fornecida com o nome fornecido.
get_at_management_group	Recuperar uma definição de política em um grupo de gerenciamento. Essa operação recupera a definição de política no grupo de gerenciamento fornecido com o nome fornecido.
get_built_in	Recupera uma definição de política interna. Essa operação recupera a definição de política interna com o nome fornecido.
list	Recupera definições de política em uma assinatura. Essa operação recupera uma lista de todas as definições de política em uma determinada assinatura que correspondem ao $filter opcional determinado. Os valores válidos para $filter são: 'atExactScope()', 'policyType -eq {value}' ou 'category eq '{value}''. Se $filter não for fornecido, a lista não filtrada incluirá todas as definições de política associadas à assinatura, incluindo aquelas que se aplicam diretamente ou de grupos de gerenciamento que contêm a assinatura fornecida. Se $filter=atExactScope() for fornecido, a lista retornada incluirá apenas todas as definições de política que estão na assinatura fornecida. Se $filter='policyType -eq {value}' for fornecido, a lista retornada incluirá apenas todas as definições de política cujo tipo corresponda ao {value}. Os valores possíveis policyType são NotSpecified, BuiltIn, Custom e Static. Se $filter='category -eq {value}' for fornecido, a lista retornada incluirá apenas todas as definições de política cuja categoria corresponda ao {value}.
list_built_in	Recuperar definições de política internas. Essa operação recupera uma lista de todas as definições de política internas que correspondem ao $filter opcional determinado. Se $filter='policyType -eq {value}' for fornecido, a lista retornada incluirá apenas todas as definições de política internas cujo tipo corresponda ao {value}. Os valores possíveis policyType são NotSpecified, BuiltIn, Custom e Static. Se $filter='category -eq {value}' for fornecido, a lista retornada incluirá apenas todas as definições de política internas cuja categoria corresponda ao {value}.
list_by_management_group	Recuperar definições de política em um grupo de gerenciamento. Essa operação recupera uma lista de todas as definições de política em um determinado grupo de gerenciamento que correspondem ao $filter opcional determinado. Os valores válidos para $filter são: 'atExactScope()', 'policyType -eq {value}' ou 'category eq '{value}''. Se $filter não for fornecido, a lista não filtrada incluirá todas as definições de política associadas ao grupo de gerenciamento, incluindo aquelas que se aplicam diretamente ou de grupos de gerenciamento que contêm o grupo de gerenciamento fornecido. Se $filter=atExactScope() for fornecido, a lista retornada incluirá apenas todas as definições de política que estão no grupo de gerenciamento fornecido. Se $filter='policyType -eq {value}' for fornecido, a lista retornada incluirá apenas todas as definições de política cujo tipo corresponda ao {value}. Os valores possíveis policyType são NotSpecified, BuiltIn, Custom e Static. Se $filter='category -eq {value}' for fornecido, a lista retornada incluirá apenas todas as definições de política cuja categoria corresponda ao {value}.

create_or_update

Cria ou atualiza uma definição de política em uma assinatura.

Essa operação cria ou atualiza uma definição de política na assinatura fornecida com o nome fornecido.

create_or_update(policy_definition_name: str, parameters: _models.PolicyDefinition, *, content_type: str = 'application/json', **kwargs: Any) -> _models.PolicyDefinition

Parâmetros

policy_definition_name

str

Obrigatório

O nome da definição de política a ser criada. Obrigatórios.

parameters

PolicyDefinition ou IO

Obrigatório

As propriedades de definição de política. É um tipo PolicyDefinition ou um tipo de E/S. Obrigatórios.

content_type

str

Body Parameter content-type. Os valores conhecidos são: 'application/json'. O valor padrão é Nenhum.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

PolicyDefinition ou o resultado de cls(response)

Tipo de retorno

PolicyDefinition

Exceções

HttpResponseError

create_or_update_at_management_group

Cria ou atualiza uma definição de política em um grupo de gerenciamento.

Essa operação cria ou atualiza uma definição de política no grupo de gerenciamento fornecido com o nome fornecido.

create_or_update_at_management_group(policy_definition_name: str, management_group_id: str, parameters: _models.PolicyDefinition, *, content_type: str = 'application/json', **kwargs: Any) -> _models.PolicyDefinition

Parâmetros

policy_definition_name

str

Obrigatório

O nome da definição de política a ser criada. Obrigatórios.

management_group_id

str

Obrigatório

A ID do grupo de gerenciamento. Obrigatórios.

parameters

PolicyDefinition ou IO

Obrigatório

As propriedades de definição de política. É um tipo PolicyDefinition ou um tipo de E/S. Obrigatórios.

content_type

str

Body Parameter content-type. Os valores conhecidos são: 'application/json'. O valor padrão é Nenhum.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

PolicyDefinition ou o resultado de cls(response)

Tipo de retorno

PolicyDefinition

Exceções

HttpResponseError

delete

Exclui uma definição de política em uma assinatura.

Essa operação exclui a definição de política na assinatura fornecida com o nome fornecido.

delete(policy_definition_name: str, **kwargs: Any) -> None

Parâmetros

policy_definition_name

str

Obrigatório

O nome da definição de política a ser excluída. Obrigatórios.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

Nenhum ou o resultado de cls(response)

Tipo de retorno

None

Exceções

HttpResponseError

delete_at_management_group

Exclui uma definição de política em um grupo de gerenciamento.

Essa operação exclui a definição de política no grupo de gerenciamento fornecido com o nome fornecido.

delete_at_management_group(policy_definition_name: str, management_group_id: str, **kwargs: Any) -> None

Parâmetros

policy_definition_name

str

Obrigatório

O nome da definição de política a ser excluída. Obrigatórios.

management_group_id

str

Obrigatório

A ID do grupo de gerenciamento. Obrigatórios.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

Nenhum ou o resultado de cls(response)

Tipo de retorno

None

Exceções

HttpResponseError

get

Recupera uma definição de política em uma assinatura.

Essa operação recupera a definição de política na assinatura fornecida com o nome fornecido.

get(policy_definition_name: str, **kwargs: Any) -> PolicyDefinition

Parâmetros

policy_definition_name

str

Obrigatório

O nome da definição de política a ser obtido. Obrigatórios.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

PolicyDefinition ou o resultado de cls(response)

Tipo de retorno

PolicyDefinition

Exceções

HttpResponseError

get_at_management_group

Recuperar uma definição de política em um grupo de gerenciamento.

Essa operação recupera a definição de política no grupo de gerenciamento fornecido com o nome fornecido.

get_at_management_group(policy_definition_name: str, management_group_id: str, **kwargs: Any) -> PolicyDefinition

Parâmetros

policy_definition_name

str

Obrigatório

O nome da definição de política a ser obtido. Obrigatórios.

management_group_id

str

Obrigatório

A ID do grupo de gerenciamento. Obrigatórios.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

PolicyDefinition ou o resultado de cls(response)

Tipo de retorno

PolicyDefinition

Exceções

HttpResponseError

get_built_in

Recupera uma definição de política interna.

Essa operação recupera a definição de política interna com o nome fornecido.

get_built_in(policy_definition_name: str, **kwargs: Any) -> PolicyDefinition

Parâmetros

policy_definition_name

str

Obrigatório

O nome da definição de política interna a ser obtido. Obrigatórios.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

PolicyDefinition ou o resultado de cls(response)

Tipo de retorno

PolicyDefinition

Exceções

HttpResponseError

list

Recupera definições de política em uma assinatura.

Essa operação recupera uma lista de todas as definições de política em uma determinada assinatura que correspondem ao $filter opcional determinado. Os valores válidos para $filter são: 'atExactScope()', 'policyType -eq {value}' ou 'category eq '{value}''. Se $filter não for fornecido, a lista não filtrada incluirá todas as definições de política associadas à assinatura, incluindo aquelas que se aplicam diretamente ou de grupos de gerenciamento que contêm a assinatura fornecida. Se $filter=atExactScope() for fornecido, a lista retornada incluirá apenas todas as definições de política que estão na assinatura fornecida. Se $filter='policyType -eq {value}' for fornecido, a lista retornada incluirá apenas todas as definições de política cujo tipo corresponda ao {value}. Os valores possíveis policyType são NotSpecified, BuiltIn, Custom e Static. Se $filter='category -eq {value}' for fornecido, a lista retornada incluirá apenas todas as definições de política cuja categoria corresponda ao {value}.

list(filter: str | None = None, top: int | None = None, **kwargs: Any) -> Iterable[PolicyDefinition]

Parâmetros

filter

str

Obrigatório

O filtro a ser aplicado na operação. Os valores válidos para $filter são: 'atExactScope()', 'policyType -eq {value}' ou 'category eq '{value}''. Se $filter não for fornecido, nenhuma filtragem será executada. Se $filter=atExactScope() for fornecido, a lista retornada incluirá apenas todas as definições de política que estão no escopo especificado. Se $filter='policyType -eq {value}' for fornecido, a lista retornada incluirá apenas todas as definições de política cujo tipo corresponda ao {value}. Os valores possíveis policyType são NotSpecified, BuiltIn, Custom e Static. Se $filter='category -eq {value}' for fornecido, a lista retornada incluirá apenas todas as definições de política cuja categoria corresponda ao {value}. O valor padrão é Nenhum.

top

int

Obrigatório

Número máximo de registros a serem retornados. Quando o filtro de $top não for fornecido, ele retornará 500 registros. O valor padrão é Nenhum.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

Um iterador como a instância de PolicyDefinition ou o resultado de cls(response)

Tipo de retorno

ItemPaged[PolicyDefinition]

Exceções

HttpResponseError

list_built_in

Recuperar definições de política internas.

Essa operação recupera uma lista de todas as definições de política internas que correspondem ao $filter opcional determinado. Se $filter='policyType -eq {value}' for fornecido, a lista retornada incluirá apenas todas as definições de política internas cujo tipo corresponda ao {value}. Os valores possíveis policyType são NotSpecified, BuiltIn, Custom e Static. Se $filter='category -eq {value}' for fornecido, a lista retornada incluirá apenas todas as definições de política internas cuja categoria corresponda ao {value}.

list_built_in(filter: str | None = None, top: int | None = None, **kwargs: Any) -> Iterable[PolicyDefinition]

Parâmetros

filter

str

Obrigatório

O filtro a ser aplicado na operação. Os valores válidos para $filter são: 'atExactScope()', 'policyType -eq {value}' ou 'category eq '{value}''. Se $filter não for fornecido, nenhuma filtragem será executada. Se $filter=atExactScope() for fornecido, a lista retornada incluirá apenas todas as definições de política que estão no escopo especificado. Se $filter='policyType -eq {value}' for fornecido, a lista retornada incluirá apenas todas as definições de política cujo tipo corresponda ao {value}. Os valores possíveis policyType são NotSpecified, BuiltIn, Custom e Static. Se $filter='category -eq {value}' for fornecido, a lista retornada incluirá apenas todas as definições de política cuja categoria corresponda ao {value}. O valor padrão é Nenhum.

top

int

Obrigatório

Número máximo de registros a serem retornados. Quando o filtro de $top não for fornecido, ele retornará 500 registros. O valor padrão é Nenhum.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

Um iterador como a instância de PolicyDefinition ou o resultado de cls(response)

Tipo de retorno

ItemPaged[PolicyDefinition]

Exceções

HttpResponseError

list_by_management_group

Recuperar definições de política em um grupo de gerenciamento.

Essa operação recupera uma lista de todas as definições de política em um determinado grupo de gerenciamento que correspondem ao $filter opcional determinado. Os valores válidos para $filter são: 'atExactScope()', 'policyType -eq {value}' ou 'category eq '{value}''. Se $filter não for fornecido, a lista não filtrada incluirá todas as definições de política associadas ao grupo de gerenciamento, incluindo aquelas que se aplicam diretamente ou de grupos de gerenciamento que contêm o grupo de gerenciamento fornecido. Se $filter=atExactScope() for fornecido, a lista retornada incluirá apenas todas as definições de política que estão no grupo de gerenciamento fornecido. Se $filter='policyType -eq {value}' for fornecido, a lista retornada incluirá apenas todas as definições de política cujo tipo corresponda ao {value}. Os valores possíveis policyType são NotSpecified, BuiltIn, Custom e Static. Se $filter='category -eq {value}' for fornecido, a lista retornada incluirá apenas todas as definições de política cuja categoria corresponda ao {value}.

list_by_management_group(management_group_id: str, filter: str | None = None, top: int | None = None, **kwargs: Any) -> Iterable[PolicyDefinition]

Parâmetros

management_group_id

str

Obrigatório

A ID do grupo de gerenciamento. Obrigatórios.

filter

str

Obrigatório

O filtro a ser aplicado na operação. Os valores válidos para $filter são: 'atExactScope()', 'policyType -eq {value}' ou 'category eq '{value}''. Se $filter não for fornecido, nenhuma filtragem será executada. Se $filter=atExactScope() for fornecido, a lista retornada incluirá apenas todas as definições de política que estão no escopo especificado. Se $filter='policyType -eq {value}' for fornecido, a lista retornada incluirá apenas todas as definições de política cujo tipo corresponda ao {value}. Os valores possíveis policyType são NotSpecified, BuiltIn, Custom e Static. Se $filter='category -eq {value}' for fornecido, a lista retornada incluirá apenas todas as definições de política cuja categoria corresponda ao {value}. O valor padrão é Nenhum.

top

int

Obrigatório

Número máximo de registros a serem retornados. Quando o filtro de $top não for fornecido, ele retornará 500 registros. O valor padrão é Nenhum.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

Um iterador como a instância de PolicyDefinition ou o resultado de cls(response)

Tipo de retorno

ItemPaged[PolicyDefinition]

Exceções

HttpResponseError

Atributos

models

models = <module 'azure.mgmt.resource.policy.v2020_09_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\resource\\policy\\v2020_09_01\\models\\__init__.py'>