PolicySetDefinitionsOperations クラス

警告

このクラスを直接インスタンス化しないでください。

代わりに、次の操作にアクセスする必要があります。

PolicyClient's

<xref:policy_set_definitions> 属性を使用する。

継承

builtins.object

PolicySetDefinitionsOperations

コンストラクター

PolicySetDefinitionsOperations(*args, **kwargs)

メソッド

create_or_update	ポリシー セット定義を作成または更新します。 この操作により、指定されたサブスクリプションのポリシー セット定義が、指定された名前で作成または更新されます。
create_or_update_at_management_group	ポリシー セット定義を作成または更新します。 この操作により、指定された管理グループ内のポリシー セット定義が、指定された名前で作成または更新されます。
delete	ポリシー セット定義を削除します。 この操作により、指定されたサブスクリプション内のポリシー セット定義が、指定された名前で削除されます。
delete_at_management_group	ポリシー セット定義を削除します。 この操作により、指定された名前の特定の管理グループ内のポリシー セット定義が削除されます。
get	ポリシー セット定義を取得します。 この操作により、指定された名前の指定されたサブスクリプション内のポリシー セット定義が取得されます。
get_at_management_group	ポリシー セット定義を取得します。 この操作により、指定された名前の特定の管理グループ内のポリシー セット定義が取得されます。
get_built_in	組み込みのポリシー セット定義を取得します。 この操作により、指定された名前の組み込みポリシー セット定義が取得されます。
list	サブスクリプションのポリシー セット定義を取得します。 この操作により、指定したサブスクリプション内のすべてのポリシー セット定義の一覧が取得され、省略可能な特定の$filterに一致します。 $filterの有効な値は、'atExactScope()'、'policyType -eq {value}' または 'category eq '{value}' です。 $filterが指定されていない場合、フィルター処理されていない一覧には、サブスクリプションに関連付けられているすべてのポリシー セット定義が含まれます。これには、直接適用されるもの、または特定のサブスクリプションを含む管理グループから適用されるものも含まれます。 $filter=atExactScope() が指定されている場合、返されるリストには、指定されたサブスクリプションにあるすべてのポリシー セット定義のみが含まれます。 $filter='policyType -eq {value}' が指定されている場合、返されるリストには、型が {value} と一致するすべてのポリシー セット定義のみが含まれます。 使用可能な policyType 値は、NotSpecified、BuiltIn、Custom です。 $filter='category -eq {value}' が指定されている場合、返されるリストには、カテゴリが {value} と一致するすべてのポリシー セット定義のみが含まれます。
list_built_in	組み込みのポリシー セット定義を取得します。 この操作により、指定されたオプションの$filterに一致するすべての組み込みポリシー セット定義の一覧が取得されます。 $filter='category -eq {value}' が指定されている場合、返されるリストには、カテゴリが {value} と一致するすべての組み込みポリシー セット定義のみが含まれます。
list_by_management_group	管理グループ内のすべてのポリシー セット定義を取得します。 この操作により、指定された管理グループ内のすべてのポリシー セット定義の一覧が取得され、オプションの指定された$filterに一致します。 $filterの有効な値は、'atExactScope()'、'policyType -eq {value}' または 'category eq '{value}' です。 $filterが指定されていない場合、フィルター処理されていないリストには、直接適用されるものや、特定の管理グループを含む管理グループから適用されるものも含め、管理グループに関連付けられているすべてのポリシー セット定義が含まれます。 $filter=atExactScope() が指定されている場合、返されるリストには、指定された管理グループにあるすべてのポリシー セット定義のみが含まれます。 $filter='policyType -eq {value}' が指定されている場合、返されるリストには、型が {value} と一致するすべてのポリシー セット定義のみが含まれます。 使用可能な policyType 値は、NotSpecified、BuiltIn、Custom です。 $filter='category -eq {value}' が指定されている場合、返されるリストには、カテゴリが {value} と一致するすべてのポリシー セット定義のみが含まれます。

create_or_update

ポリシー セット定義を作成または更新します。

この操作により、指定されたサブスクリプションのポリシー セット定義が、指定された名前で作成または更新されます。

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

パラメーター

policy_set_definition_name

str

必須

作成するポリシー セット定義の名前。 必須。

parameters

PolicySetDefinition または IO

必須

ポリシー セット定義のプロパティ。 PolicySetDefinition 型または IO 型です。 必須。

content_type

str

Body Parameter content-type。 既知の値は、'application/json' です。 既定値は [なし] です。

cls

callable

直接応答に渡されるカスタム型または関数

戻り値

PolicySetDefinition または cls(response) の結果

の戻り値の型 :

PolicySetDefinition

例外

HttpResponseError

create_or_update_at_management_group

ポリシー セット定義を作成または更新します。

この操作により、指定された管理グループ内のポリシー セット定義が、指定された名前で作成または更新されます。

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

パラメーター

policy_set_definition_name

str

必須

作成するポリシー セット定義の名前。 必須。

management_group_id

str

必須

管理グループの ID。 必須。

parameters

PolicySetDefinition または IO

必須

ポリシー セット定義のプロパティ。 PolicySetDefinition 型または IO 型です。 必須。

content_type

str

Body Parameter content-type。 既知の値は、'application/json' です。 既定値は [なし] です。

cls

callable

直接応答に渡されるカスタム型または関数

戻り値

PolicySetDefinition または cls(response) の結果

の戻り値の型 :

PolicySetDefinition

例外

HttpResponseError

delete

ポリシー セット定義を削除します。

この操作により、指定されたサブスクリプション内のポリシー セット定義が、指定された名前で削除されます。

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

パラメーター

policy_set_definition_name

str

必須

削除するポリシー セット定義の名前。 必須。

cls

callable

直接応答に渡されるカスタム型または関数

戻り値

なし、または cls(response) の結果

の戻り値の型 :

None

例外

HttpResponseError

delete_at_management_group

ポリシー セット定義を削除します。

この操作により、指定された名前の特定の管理グループ内のポリシー セット定義が削除されます。

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

パラメーター

policy_set_definition_name

str

必須

削除するポリシー セット定義の名前。 必須。

management_group_id

str

必須

管理グループの ID。 必須。

cls

callable

直接応答に渡されるカスタム型または関数

戻り値

なし、または cls(response) の結果

の戻り値の型 :

None

例外

HttpResponseError

get

ポリシー セット定義を取得します。

この操作により、指定された名前の指定されたサブスクリプション内のポリシー セット定義が取得されます。

get(policy_set_definition_name: str, **kwargs: Any) -> PolicySetDefinition

パラメーター

policy_set_definition_name

str

必須

取得するポリシー セット定義の名前。 必須。

cls

callable

直接応答に渡されるカスタム型または関数

戻り値

PolicySetDefinition または cls(response) の結果

の戻り値の型 :

PolicySetDefinition

例外

HttpResponseError

get_at_management_group

ポリシー セット定義を取得します。

この操作により、指定された名前の特定の管理グループ内のポリシー セット定義が取得されます。

get_at_management_group(policy_set_definition_name: str, management_group_id: str, **kwargs: Any) -> PolicySetDefinition

パラメーター

policy_set_definition_name

str

必須

取得するポリシー セット定義の名前。 必須。

management_group_id

str

必須

管理グループの ID。 必須。

cls

callable

直接応答に渡されるカスタム型または関数

戻り値

PolicySetDefinition または cls(response) の結果

の戻り値の型 :

PolicySetDefinition

例外

HttpResponseError

get_built_in

組み込みのポリシー セット定義を取得します。

この操作により、指定された名前の組み込みポリシー セット定義が取得されます。

get_built_in(policy_set_definition_name: str, **kwargs: Any) -> PolicySetDefinition

パラメーター

policy_set_definition_name

str

必須

取得するポリシー セット定義の名前。 必須。

cls

callable

直接応答に渡されるカスタム型または関数

戻り値

PolicySetDefinition または cls(response) の結果

の戻り値の型 :

PolicySetDefinition

例外

HttpResponseError

list

サブスクリプションのポリシー セット定義を取得します。

この操作により、指定したサブスクリプション内のすべてのポリシー セット定義の一覧が取得され、省略可能な特定の$filterに一致します。 $filterの有効な値は、'atExactScope()'、'policyType -eq {value}' または 'category eq '{value}' です。 $filterが指定されていない場合、フィルター処理されていない一覧には、サブスクリプションに関連付けられているすべてのポリシー セット定義が含まれます。これには、直接適用されるもの、または特定のサブスクリプションを含む管理グループから適用されるものも含まれます。 $filter=atExactScope() が指定されている場合、返されるリストには、指定されたサブスクリプションにあるすべてのポリシー セット定義のみが含まれます。 $filter='policyType -eq {value}' が指定されている場合、返されるリストには、型が {value} と一致するすべてのポリシー セット定義のみが含まれます。 使用可能な policyType 値は、NotSpecified、BuiltIn、Custom です。 $filter='category -eq {value}' が指定されている場合、返されるリストには、カテゴリが {value} と一致するすべてのポリシー セット定義のみが含まれます。

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

パラメーター

filter

str

必須

操作に適用するフィルター。 $filterの有効な値は、'atExactScope()'、'policyType -eq {value}' または 'category eq '{value}' です。 $filterが指定されていない場合、フィルター処理は実行されません。 $filter=atExactScope() が指定されている場合、返されるリストには、指定されたスコープにあるすべてのポリシー セット定義のみが含まれます。 $filter='policyType -eq {value}' が指定されている場合、返されるリストには、型が {value} と一致するすべてのポリシー セット定義のみが含まれます。 使用可能な policyType 値は、NotSpecified、BuiltIn、Custom、Static です。 $filter='category -eq {value}' が指定されている場合、返されるリストには、カテゴリが {value} と一致するすべてのポリシー セット定義のみが含まれます。 既定値は [なし] です。

top

int

必須

返されるレコードの最大数。 $top フィルターが指定されていない場合は、500 個のレコードが返されます。 既定値は [なし] です。

cls

callable

直接応答に渡されるカスタム型または関数

戻り値

PolicySetDefinition のインスタンスや cls(response) の結果のような反復子

の戻り値の型 :

ItemPaged[PolicySetDefinition]

例外

HttpResponseError

list_built_in

組み込みのポリシー セット定義を取得します。

この操作により、指定されたオプションの$filterに一致するすべての組み込みポリシー セット定義の一覧が取得されます。 $filter='category -eq {value}' が指定されている場合、返されるリストには、カテゴリが {value} と一致するすべての組み込みポリシー セット定義のみが含まれます。

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

パラメーター

filter

str

必須

操作に適用するフィルター。 $filterの有効な値は、'atExactScope()'、'policyType -eq {value}' または 'category eq '{value}' です。 $filterが指定されていない場合、フィルター処理は実行されません。 $filter=atExactScope() が指定されている場合、返されるリストには、指定されたスコープにあるすべてのポリシー セット定義のみが含まれます。 $filter='policyType -eq {value}' が指定されている場合、返されるリストには、型が {value} と一致するすべてのポリシー セット定義のみが含まれます。 使用可能な policyType 値は、NotSpecified、BuiltIn、Custom、Static です。 $filter='category -eq {value}' が指定されている場合、返されるリストには、カテゴリが {value} と一致するすべてのポリシー セット定義のみが含まれます。 既定値は [なし] です。

top

int

必須

返されるレコードの最大数。 $top フィルターが指定されていない場合、500 レコードが返されます。 既定値は [なし] です。

cls

callable

直接応答が渡されるカスタム型または関数

戻り値

PolicySetDefinition または cls(response) の結果のいずれかのインスタンスのような反復子

の戻り値の型 :

ItemPaged[PolicySetDefinition]

例外

HttpResponseError

list_by_management_group

管理グループ内のすべてのポリシー セット定義を取得します。

この操作により、指定された管理グループ内のすべてのポリシー セット定義の一覧が取得され、オプションの指定された$filterに一致します。 $filterの有効な値は、'atExactScope()'、'policyType -eq {value}' または 'category eq '{value}' です。 $filterが指定されていない場合、フィルター処理されていないリストには、直接適用されるものや、特定の管理グループを含む管理グループから適用されるものも含め、管理グループに関連付けられているすべてのポリシー セット定義が含まれます。 $filter=atExactScope() が指定されている場合、返されるリストには、指定された管理グループにあるすべてのポリシー セット定義のみが含まれます。 $filter='policyType -eq {value}' が指定されている場合、返されるリストには、型が {value} と一致するすべてのポリシー セット定義のみが含まれます。 使用可能な policyType 値は、NotSpecified、BuiltIn、Custom です。 $filter='category -eq {value}' が指定されている場合、返されるリストには、カテゴリが {value} と一致するすべてのポリシー セット定義のみが含まれます。

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

パラメーター

management_group_id

str

必須

管理グループの ID。 必須。

filter

str

必須

操作に適用するフィルター。 $filterの有効な値は、'atExactScope()'、'policyType -eq {value}' または 'category eq '{value}' です。 $filterが指定されていない場合、フィルター処理は実行されません。 $filter=atExactScope() が指定されている場合、返されるリストには、指定されたスコープにあるすべてのポリシー セット定義のみが含まれます。 $filter='policyType -eq {value}' が指定されている場合、返されるリストには、型が {value} と一致するすべてのポリシー セット定義のみが含まれます。 使用可能な policyType 値は、NotSpecified、BuiltIn、Custom、Static です。 $filter='category -eq {value}' が指定されている場合、返されるリストには、カテゴリが {value} と一致するすべてのポリシー セット定義のみが含まれます。 既定値は [なし] です。

top

int

必須

返されるレコードの最大数。 $top フィルターが指定されていない場合、500 レコードが返されます。 既定値は [なし] です。

cls

callable

直接応答が渡されるカスタム型または関数

戻り値

PolicySetDefinition または cls(response) の結果のいずれかのインスタンスのような反復子

の戻り値の型 :

ItemPaged[PolicySetDefinition]

例外

HttpResponseError

属性

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