PolicyDefinitionsOperations Classe

Aviso

NÃO instanciar esta classe diretamente.

Em vez disso, deve aceder às seguintes operações através de

PolicyClient's

<xref:policy_definitions> atributo.

Herança

builtins.object

PolicyDefinitionsOperations

Construtor

PolicyDefinitionsOperations(*args, **kwargs)

Métodos

create_or_update	Cria ou atualiza uma definição de política numa subscrição. Esta operação cria ou atualiza uma definição de política na subscrição especificada com o nome especificado.
create_or_update_at_management_group	Cria ou atualiza uma definição de política num grupo de gestão. Esta operação cria ou atualiza uma definição de política no grupo de gestão especificado com o nome especificado.
delete	Elimina uma definição de política numa subscrição. Esta operação elimina a definição de política na subscrição especificada com o nome especificado.
delete_at_management_group	Elimina uma definição de política num grupo de gestão. Esta operação elimina a definição de política no grupo de gestão especificado com o nome especificado.
get	Obtém uma definição de política numa subscrição. Esta operação obtém a definição de política na subscrição especificada com o nome especificado.
get_at_management_group	Obter uma definição de política num grupo de gestão. Esta operação obtém a definição de política no grupo de gestão especificado com o nome especificado.
get_built_in	Obtém uma definição de política incorporada. Esta operação obtém a definição de política incorporada com o nome especificado.
list	Obtém definições de política numa subscrição. Esta operação obtém uma lista de todas as definições de política numa determinada subscrição que correspondem ao $filter opcional especificado. 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 inclui todas as definições de política associadas à subscrição, incluindo as que se aplicam diretamente ou a partir de grupos de gestão que contêm a subscrição especificada. Se $filter=atExactScope() for fornecido, a lista devolvida inclui apenas todas as definições de política na subscrição especificada. Se $filter='policyType -eq {value}' for fornecido, a lista devolvida inclui apenas todas as definições de política cujo tipo corresponde ao {value}. Os possíveis valores policyType são NotSpecified, BuiltIn, Custom e Static. Se $filter='category -eq {value}' for fornecido, a lista devolvida inclui apenas todas as definições de política cuja categoria corresponde ao {value}.
list_built_in	Obter definições de política incorporadas. Esta operação obtém uma lista de todas as definições de política incorporadas que correspondem ao $filter opcional especificado. Se $filter='policyType -eq {value}' for fornecido, a lista devolvida inclui apenas todas as definições de política incorporadas cujo tipo corresponde ao {value}. Os possíveis valores policyType são NotSpecified, BuiltIn, Custom e Static. Se $filter='category -eq {value}' for fornecido, a lista devolvida inclui apenas todas as definições de política incorporadas cuja categoria corresponde ao {value}.
list_by_management_group	Obter definições de política num grupo de gestão. Esta operação obtém uma lista de todas as definições de política num determinado grupo de gestão que correspondem ao $filter opcional fornecido. Os valores válidos para $filter são: "atExactScope()", "policyType -eq {value}" ou "category eq '{value}'". Se $filter não for fornecida, a lista não filtrada inclui todas as definições de política associadas ao grupo de gestão, incluindo as que se aplicam diretamente ou a partir de grupos de gestão que contêm o grupo de gestão especificado. Se $filter=atExactScope() for fornecido, a lista devolvida inclui apenas todas as definições de política que estejam no grupo de gestão especificado. Se $filter='policyType -eq {value}' for fornecido, a lista devolvida inclui apenas todas as definições de política cujo tipo corresponde ao {value}. Os possíveis valores policyType são NotSpecified, BuiltIn, Custom e Static. Se $filter='category -eq {value}' for fornecido, a lista devolvida inclui apenas todas as definições de política cuja categoria corresponde ao {value}.

create_or_update

Cria ou atualiza uma definição de política numa subscrição.

Esta operação cria ou atualiza uma definição de política na subscrição especificada com o nome especificado.

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

Necessário

O nome da definição de política a criar. Obrigatório.

parameters

PolicyDefinition ou IO

Necessário

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

content_type

str

Tipo de conteúdo do Parâmetro do Corpo. Os valores conhecidos são: "application/json". O valor predefinido é Nenhum.

cls

callable

Um tipo ou função personalizado que será transmitido à resposta direta

Devoluções

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 num grupo de gestão.

Esta operação cria ou atualiza uma definição de política no grupo de gestão especificado com o nome especificado.

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

Necessário

O nome da definição de política a criar. Obrigatório.

management_group_id

str

Necessário

O ID do grupo de gestão. Obrigatório.

parameters

PolicyDefinition ou IO

Necessário

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

content_type

str

Tipo de conteúdo do Parâmetro do Corpo. Os valores conhecidos são: "application/json". O valor predefinido é Nenhum.

cls

callable

Um tipo ou função personalizado que será transmitido à resposta direta

Devoluções

PolicyDefinition ou o resultado de cls(response)

Tipo de retorno

PolicyDefinition

Exceções

HttpResponseError

delete

Elimina uma definição de política numa subscrição.

Esta operação elimina a definição de política na subscrição especificada com o nome especificado.

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

Parâmetros

policy_definition_name

str

Necessário

O nome da definição de política a eliminar. Obrigatório.

cls

callable

Um tipo ou função personalizado que será transmitido à resposta direta

Devoluções

Nenhum ou o resultado de cls(response)

Tipo de retorno

None

Exceções

HttpResponseError

delete_at_management_group

Elimina uma definição de política num grupo de gestão.

Esta operação elimina a definição de política no grupo de gestão especificado com o nome especificado.

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

Parâmetros

policy_definition_name

str

Necessário

O nome da definição de política a eliminar. Obrigatório.

management_group_id

str

Necessário

O ID do grupo de gestão. Obrigatório.

cls

callable

Um tipo ou função personalizado que será transmitido à resposta direta

Devoluções

Nenhum ou o resultado de cls(response)

Tipo de retorno

None

Exceções

HttpResponseError

get

Obtém uma definição de política numa subscrição.

Esta operação obtém a definição de política na subscrição especificada com o nome especificado.

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

Parâmetros

policy_definition_name

str

Necessário

O nome da definição de política a obter. Obrigatório.

cls

callable

Um tipo ou função personalizado que será transmitido à resposta direta

Devoluções

PolicyDefinition ou o resultado de cls(response)

Tipo de retorno

PolicyDefinition

Exceções

HttpResponseError

get_at_management_group

Obter uma definição de política num grupo de gestão.

Esta operação obtém a definição de política no grupo de gestão especificado com o nome especificado.

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

Parâmetros

policy_definition_name

str

Necessário

O nome da definição de política a obter. Obrigatório.

management_group_id

str

Necessário

O ID do grupo de gestão. Obrigatório.

cls

callable

Um tipo ou função personalizado que será transmitido à resposta direta

Devoluções

PolicyDefinition ou o resultado de cls(response)

Tipo de retorno

PolicyDefinition

Exceções

HttpResponseError

get_built_in

Obtém uma definição de política incorporada.

Esta operação obtém a definição de política incorporada com o nome especificado.

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

Parâmetros

policy_definition_name

str

Necessário

O nome da definição de política incorporada a obter. Obrigatório.

cls

callable

Um tipo ou função personalizado que será transmitido à resposta direta

Devoluções

PolicyDefinition ou o resultado de cls(response)

Tipo de retorno

PolicyDefinition

Exceções

HttpResponseError

list

Obtém definições de política numa subscrição.

Esta operação obtém uma lista de todas as definições de política numa determinada subscrição que correspondem ao $filter opcional especificado. 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 inclui todas as definições de política associadas à subscrição, incluindo as que se aplicam diretamente ou a partir de grupos de gestão que contêm a subscrição especificada. Se $filter=atExactScope() for fornecido, a lista devolvida inclui apenas todas as definições de política na subscrição especificada. Se $filter='policyType -eq {value}' for fornecido, a lista devolvida inclui apenas todas as definições de política cujo tipo corresponde ao {value}. Os possíveis valores policyType são NotSpecified, BuiltIn, Custom e Static. Se $filter='category -eq {value}' for fornecido, a lista devolvida inclui apenas todas as definições de política cuja categoria corresponde ao {value}.

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

Parâmetros

filter

str

Necessário

O filtro a aplicar na operação. Os valores válidos para $filter são: "atExactScope()", "policyType -eq {value}" ou "category eq '{value}'". Se não for fornecido $filter, não é efetuada qualquer filtragem. Se for fornecido $filter=atExactScope(), a lista devolvida inclui apenas todas as definições de política que estejam no âmbito especificado. Se $filter='policyType -eq {value}' for fornecido, a lista devolvida inclui apenas todas as definições de política cujo tipo corresponde ao {value}. Os possíveis valores policyType são NotSpecified, BuiltIn, Custom e Static. Se $filter='category -eq {value}' for fornecido, a lista devolvida inclui apenas todas as definições de política cuja categoria corresponde ao {value}. O valor predefinido é Nenhum.

top

int

Necessário

Número máximo de registos a devolver. Quando o filtro $top não for fornecido, irá devolver 500 registos. O valor predefinido é Nenhum.

cls

callable

Um tipo ou função personalizado que será transmitido à resposta direta

Devoluções

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

Obter definições de política incorporadas.

Esta operação obtém uma lista de todas as definições de política incorporadas que correspondem ao $filter opcional especificado. Se $filter='policyType -eq {value}' for fornecido, a lista devolvida inclui apenas todas as definições de política incorporadas cujo tipo corresponde ao {value}. Os possíveis valores policyType são NotSpecified, BuiltIn, Custom e Static. Se $filter='category -eq {value}' for fornecido, a lista devolvida inclui apenas todas as definições de política incorporadas cuja categoria corresponde ao {value}.

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

Parâmetros

filter

str

Necessário

O filtro a aplicar na operação. Os valores válidos para $filter são: "atExactScope()", "policyType -eq {value}" ou "category eq '{value}'". Se não for fornecido $filter, não é efetuada qualquer filtragem. Se for fornecido $filter=atExactScope(), a lista devolvida inclui apenas todas as definições de política que estejam no âmbito especificado. Se $filter='policyType -eq {value}' for fornecido, a lista devolvida inclui apenas todas as definições de política cujo tipo corresponde ao {value}. Os possíveis valores policyType são NotSpecified, BuiltIn, Custom e Static. Se $filter='category -eq {value}' for fornecido, a lista devolvida inclui apenas todas as definições de política cuja categoria corresponde ao {value}. O valor predefinido é Nenhum.

top

int

Necessário

Número máximo de registos a devolver. Quando o filtro $top não for fornecido, irá devolver 500 registos. O valor predefinido é Nenhum.

cls

callable

Um tipo ou função personalizado que será transmitido à resposta direta

Devoluções

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

Obter definições de política num grupo de gestão.

Esta operação obtém uma lista de todas as definições de política num determinado grupo de gestão que correspondem ao $filter opcional fornecido. Os valores válidos para $filter são: "atExactScope()", "policyType -eq {value}" ou "category eq '{value}'". Se $filter não for fornecida, a lista não filtrada inclui todas as definições de política associadas ao grupo de gestão, incluindo as que se aplicam diretamente ou a partir de grupos de gestão que contêm o grupo de gestão especificado. Se $filter=atExactScope() for fornecido, a lista devolvida inclui apenas todas as definições de política que estejam no grupo de gestão especificado. Se $filter='policyType -eq {value}' for fornecido, a lista devolvida inclui apenas todas as definições de política cujo tipo corresponde ao {value}. Os possíveis valores policyType são NotSpecified, BuiltIn, Custom e Static. Se $filter='category -eq {value}' for fornecido, a lista devolvida inclui apenas todas as definições de política cuja categoria corresponde 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

Necessário

O ID do grupo de gestão. Obrigatório.

filter

str

Necessário

O filtro a aplicar na operação. Os valores válidos para $filter são: "atExactScope()", "policyType -eq {value}" ou "category eq '{value}'". Se não for fornecido $filter, não é efetuada qualquer filtragem. Se for fornecido $filter=atExactScope(), a lista devolvida inclui apenas todas as definições de política que estejam no âmbito especificado. Se $filter='policyType -eq {value}' for fornecido, a lista devolvida inclui apenas todas as definições de política cujo tipo corresponde ao {value}. Os possíveis valores policyType são NotSpecified, BuiltIn, Custom e Static. Se $filter='category -eq {value}' for fornecido, a lista devolvida inclui apenas todas as definições de política cuja categoria corresponde ao {value}. O valor predefinido é Nenhum.

top

int

Necessário

Número máximo de registos a devolver. Quando o filtro $top não for fornecido, irá devolver 500 registos. O valor predefinido é Nenhum.

cls

callable

Um tipo ou função personalizado que será transmitido à resposta direta

Devoluções

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'>