PolicySetDefinitions interface

パッケージ:

@azure/arm-policy

PolicySetDefinitions を表すインターフェイス。

メソッド

createOrUpdate(string, PolicySetDefinition, PolicySetDefinitionsCreateOrUpdateOptionalParams)	この操作により、指定されたサブスクリプション内のポリシー セット定義が、指定された名前で作成または更新されます。
createOrUpdateAtManagementGroup(string, string, PolicySetDefinition, PolicySetDefinitionsCreateOrUpdateAtManagementGroupOptionalParams)	この操作により、特定の管理グループ内のポリシー セット定義が、指定された名前で作成または更新されます。
delete(string, PolicySetDefinitionsDeleteOptionalParams)	この操作により、指定されたサブスクリプション内のポリシー セット定義が、指定された名前で削除されます。
deleteAtManagementGroup(string, string, PolicySetDefinitionsDeleteAtManagementGroupOptionalParams)	この操作により、指定された名前の特定の管理グループ内のポリシー セット定義が削除されます。
get(string, PolicySetDefinitionsGetOptionalParams)	この操作は、指定された名前を持つ特定のサブスクリプションのポリシー セット定義を取得します。
getAtManagementGroup(string, string, PolicySetDefinitionsGetAtManagementGroupOptionalParams)	この操作では、指定された名前を持つ特定の管理グループ内のポリシー セット定義を取得します。
getBuiltIn(string, PolicySetDefinitionsGetBuiltInOptionalParams)	この操作では、指定された名前を持つ組み込みのポリシー セット定義を取得します。
list(PolicySetDefinitionsListOptionalParams)	この操作は、指定したサブスクリプション内のすべてのポリシー セット定義の一覧を取得します。この定義は、指定された$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} と一致するすべてのポリシー セット定義のみが含まれます。
listBuiltIn(PolicySetDefinitionsListBuiltInOptionalParams)	この操作では、指定したオプションの$filterに一致するすべての組み込みポリシー セット定義の一覧が取得されます。 $filter='category -eq {value}' が指定されている場合、返されるリストには、カテゴリが {value} と一致するすべての組み込みポリシー セット定義のみが含まれます。
listByManagementGroup(string, PolicySetDefinitionsListByManagementGroupOptionalParams)	この操作は、指定された管理グループ内のすべてのポリシー セット定義のリストを取得します。この定義は、省略可能な特定の$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} と一致するすべてのポリシー セット定義のみが含まれます。

メソッドの詳細

createOrUpdate(string, PolicySetDefinition, PolicySetDefinitionsCreateOrUpdateOptionalParams)

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

function createOrUpdate(policySetDefinitionName: string, parameters: PolicySetDefinition, options?: PolicySetDefinitionsCreateOrUpdateOptionalParams): Promise<PolicySetDefinition>

パラメーター

policySetDefinitionName

string

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

parameters

PolicySetDefinition

ポリシー セット定義のプロパティ。

options

PolicySetDefinitionsCreateOrUpdateOptionalParams

オプション パラメーター。

戻り値

Promise<PolicySetDefinition>

createOrUpdateAtManagementGroup(string, string, PolicySetDefinition, PolicySetDefinitionsCreateOrUpdateAtManagementGroupOptionalParams)

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

function createOrUpdateAtManagementGroup(managementGroupId: string, policySetDefinitionName: string, parameters: PolicySetDefinition, options?: PolicySetDefinitionsCreateOrUpdateAtManagementGroupOptionalParams): Promise<PolicySetDefinition>

パラメーター

managementGroupId

string

管理グループの ID。

policySetDefinitionName

string

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

parameters

PolicySetDefinition

ポリシー セット定義のプロパティ。

options

PolicySetDefinitionsCreateOrUpdateAtManagementGroupOptionalParams

オプション パラメーター。

戻り値

Promise<PolicySetDefinition>

delete(string, PolicySetDefinitionsDeleteOptionalParams)

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

function delete(policySetDefinitionName: string, options?: PolicySetDefinitionsDeleteOptionalParams): Promise<void>

パラメーター

policySetDefinitionName

string

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

options

PolicySetDefinitionsDeleteOptionalParams

オプション パラメーター。

戻り値

Promise<void>

deleteAtManagementGroup(string, string, PolicySetDefinitionsDeleteAtManagementGroupOptionalParams)

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

function deleteAtManagementGroup(managementGroupId: string, policySetDefinitionName: string, options?: PolicySetDefinitionsDeleteAtManagementGroupOptionalParams): Promise<void>

パラメーター

managementGroupId

string

管理グループの ID。

policySetDefinitionName

string

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

options

PolicySetDefinitionsDeleteAtManagementGroupOptionalParams

オプション パラメーター。

戻り値

Promise<void>

get(string, PolicySetDefinitionsGetOptionalParams)

この操作は、指定された名前を持つ特定のサブスクリプションのポリシー セット定義を取得します。

function get(policySetDefinitionName: string, options?: PolicySetDefinitionsGetOptionalParams): Promise<PolicySetDefinition>

パラメーター

policySetDefinitionName

string

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

options

PolicySetDefinitionsGetOptionalParams

オプション パラメーター。

戻り値

Promise<PolicySetDefinition>

getAtManagementGroup(string, string, PolicySetDefinitionsGetAtManagementGroupOptionalParams)

この操作では、指定された名前を持つ特定の管理グループ内のポリシー セット定義を取得します。

function getAtManagementGroup(managementGroupId: string, policySetDefinitionName: string, options?: PolicySetDefinitionsGetAtManagementGroupOptionalParams): Promise<PolicySetDefinition>

パラメーター

managementGroupId

string

管理グループの ID。

policySetDefinitionName

string

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

options

PolicySetDefinitionsGetAtManagementGroupOptionalParams

オプション パラメーター。

戻り値

Promise<PolicySetDefinition>

getBuiltIn(string, PolicySetDefinitionsGetBuiltInOptionalParams)

この操作では、指定された名前を持つ組み込みのポリシー セット定義を取得します。

function getBuiltIn(policySetDefinitionName: string, options?: PolicySetDefinitionsGetBuiltInOptionalParams): Promise<PolicySetDefinition>

パラメーター

policySetDefinitionName

string

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

options

PolicySetDefinitionsGetBuiltInOptionalParams

オプション パラメーター。

戻り値

Promise<PolicySetDefinition>

list(PolicySetDefinitionsListOptionalParams)

この操作は、指定したサブスクリプション内のすべてのポリシー セット定義の一覧を取得します。この定義は、指定された$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} と一致するすべてのポリシー セット定義のみが含まれます。

function list(options?: PolicySetDefinitionsListOptionalParams): PagedAsyncIterableIterator<PolicySetDefinition, PolicySetDefinition[], PageSettings>

パラメーター

options

PolicySetDefinitionsListOptionalParams

オプション パラメーター。

戻り値

PagedAsyncIterableIterator<PolicySetDefinition, PolicySetDefinition[], PageSettings>

listBuiltIn(PolicySetDefinitionsListBuiltInOptionalParams)

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

function listBuiltIn(options?: PolicySetDefinitionsListBuiltInOptionalParams): PagedAsyncIterableIterator<PolicySetDefinition, PolicySetDefinition[], PageSettings>

パラメーター

options

PolicySetDefinitionsListBuiltInOptionalParams

オプション パラメーター。

戻り値

PagedAsyncIterableIterator<PolicySetDefinition, PolicySetDefinition[], PageSettings>

listByManagementGroup(string, PolicySetDefinitionsListByManagementGroupOptionalParams)

この操作は、指定された管理グループ内のすべてのポリシー セット定義のリストを取得します。この定義は、省略可能な特定の$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} と一致するすべてのポリシー セット定義のみが含まれます。

function listByManagementGroup(managementGroupId: string, options?: PolicySetDefinitionsListByManagementGroupOptionalParams): PagedAsyncIterableIterator<PolicySetDefinition, PolicySetDefinition[], PageSettings>

パラメーター

managementGroupId

string

管理グループの ID。

options

PolicySetDefinitionsListByManagementGroupOptionalParams

オプション パラメーター。

戻り値

PagedAsyncIterableIterator<PolicySetDefinition, PolicySetDefinition[], PageSettings>