PolicySetDefinitions interface
PolicySetDefinitions を表すインターフェイス。
メソッド
| create |
この操作により、指定されたサブスクリプションのポリシー セット定義が、指定された名前で作成または更新されます。 |
| create |
この操作により、指定された管理グループ内のポリシー セット定義が、指定された名前で作成または更新されます。 |
| delete(string, Policy |
この操作により、指定されたサブスクリプション内のポリシー セット定義が、指定された名前で削除されます。 |
| delete |
この操作により、指定された名前の特定の管理グループ内のポリシー セット定義が削除されます。 |
| get(string, Policy |
この操作により、指定された名前の指定されたサブスクリプション内のポリシー セット定義が取得されます。 |
| get |
この操作により、指定された名前の特定の管理グループ内のポリシー セット定義が取得されます。 |
| get |
この操作により、指定された名前の組み込みポリシー セット定義が取得されます。 |
| list(Policy |
この操作により、指定したサブスクリプション内のすべてのポリシー セット定義の一覧が取得され、省略可能な特定の$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に一致するすべての組み込みポリシー セット定義の一覧が取得されます。 $filter='category -eq {value}' が指定されている場合、返されるリストには、カテゴリが {value} と一致するすべての組み込みポリシー セット定義のみが含まれます。 |
| 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} と一致するすべてのポリシー セット定義のみが含まれます。 |
メソッドの詳細
createOrUpdate(string, PolicySetDefinition, PolicySetDefinitionsCreateOrUpdateOptionalParams)
この操作により、指定されたサブスクリプションのポリシー セット定義が、指定された名前で作成または更新されます。
function createOrUpdate(policySetDefinitionName: string, parameters: PolicySetDefinition, options?: PolicySetDefinitionsCreateOrUpdateOptionalParams): Promise<PolicySetDefinition>パラメーター
- policySetDefinitionName
-
string
作成するポリシー セット定義の名前。
- parameters
- PolicySetDefinition
ポリシー セット定義のプロパティ。
options パラメーター。
戻り値
Promise<PolicySetDefinition>
createOrUpdateAtManagementGroup(string, string, PolicySetDefinition, PolicySetDefinitionsCreateOrUpdateAtManagementGroupOptionalParams)
この操作により、指定された管理グループ内のポリシー セット定義が、指定された名前で作成または更新されます。
function createOrUpdateAtManagementGroup(policySetDefinitionName: string, managementGroupId: string, parameters: PolicySetDefinition, options?: PolicySetDefinitionsCreateOrUpdateAtManagementGroupOptionalParams): Promise<PolicySetDefinition>パラメーター
- policySetDefinitionName
-
string
作成するポリシー セット定義の名前。
- managementGroupId
-
string
管理グループの ID。
- parameters
- PolicySetDefinition
ポリシー セット定義のプロパティ。
options パラメーター。
戻り値
Promise<PolicySetDefinition>
delete(string, PolicySetDefinitionsDeleteOptionalParams)
この操作により、指定されたサブスクリプション内のポリシー セット定義が、指定された名前で削除されます。
function delete(policySetDefinitionName: string, options?: PolicySetDefinitionsDeleteOptionalParams): Promise<void>パラメーター
- policySetDefinitionName
-
string
削除するポリシー セット定義の名前。
options パラメーター。
戻り値
Promise<void>
deleteAtManagementGroup(string, string, PolicySetDefinitionsDeleteAtManagementGroupOptionalParams)
この操作により、指定された名前の特定の管理グループ内のポリシー セット定義が削除されます。
function deleteAtManagementGroup(policySetDefinitionName: string, managementGroupId: string, options?: PolicySetDefinitionsDeleteAtManagementGroupOptionalParams): Promise<void>パラメーター
- policySetDefinitionName
-
string
削除するポリシー セット定義の名前。
- managementGroupId
-
string
管理グループの ID。
options パラメーター。
戻り値
Promise<void>
get(string, PolicySetDefinitionsGetOptionalParams)
この操作により、指定された名前の指定されたサブスクリプション内のポリシー セット定義が取得されます。
function get(policySetDefinitionName: string, options?: PolicySetDefinitionsGetOptionalParams): Promise<PolicySetDefinition>パラメーター
- policySetDefinitionName
-
string
取得するポリシー セット定義の名前。
options パラメーター。
戻り値
Promise<PolicySetDefinition>
getAtManagementGroup(string, string, PolicySetDefinitionsGetAtManagementGroupOptionalParams)
この操作により、指定された名前の特定の管理グループ内のポリシー セット定義が取得されます。
function getAtManagementGroup(policySetDefinitionName: string, managementGroupId: string, options?: PolicySetDefinitionsGetAtManagementGroupOptionalParams): Promise<PolicySetDefinition>パラメーター
- policySetDefinitionName
-
string
取得するポリシー セット定義の名前。
- managementGroupId
-
string
管理グループの ID。
options パラメーター。
戻り値
Promise<PolicySetDefinition>
getBuiltIn(string, PolicySetDefinitionsGetBuiltInOptionalParams)
この操作により、指定された名前の組み込みポリシー セット定義が取得されます。
function getBuiltIn(policySetDefinitionName: string, options?: PolicySetDefinitionsGetBuiltInOptionalParams): Promise<PolicySetDefinition>パラメーター
- policySetDefinitionName
-
string
取得するポリシー セット定義の名前。
options パラメーター。
戻り値
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 パラメーター。
戻り値
listBuiltIn(PolicySetDefinitionsListBuiltInOptionalParams)
この操作により、指定されたオプションの$filterに一致するすべての組み込みポリシー セット定義の一覧が取得されます。 $filter='category -eq {value}' が指定されている場合、返されるリストには、カテゴリが {value} と一致するすべての組み込みポリシー セット定義のみが含まれます。
function listBuiltIn(options?: PolicySetDefinitionsListBuiltInOptionalParams): PagedAsyncIterableIterator<PolicySetDefinition, PolicySetDefinition[], PageSettings>パラメーター
options パラメーター。
戻り値
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 パラメーター。