PolicyDefinitions interface
PolicyDefinitions を表すインターフェイス。
メソッド
| 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、Static です。 $filter='category -eq {value}' が指定されている場合、返されるリストには、カテゴリが {value} と一致するすべてのポリシー定義のみが含まれます。 |
| list |
この操作により、オプションの指定した$filterに一致するすべての組み込みポリシー定義の一覧が取得されます。 $filter='policyType -eq {value}' が指定されている場合、返されるリストには、型が {value} と一致するすべての組み込みポリシー定義のみが含まれます。 使用可能な policyType 値は、NotSpecified、BuiltIn、Custom、Static です。 $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、Static です。 $filter='category -eq {value}' が指定されている場合、返されるリストには、カテゴリが {value} と一致するすべてのポリシー定義のみが含まれます。 |
メソッドの詳細
createOrUpdate(string, PolicyDefinition, PolicyDefinitionsCreateOrUpdateOptionalParams)
この操作により、指定されたサブスクリプション内のポリシー定義が、指定された名前で作成または更新されます。
function createOrUpdate(policyDefinitionName: string, parameters: PolicyDefinition, options?: PolicyDefinitionsCreateOrUpdateOptionalParams): Promise<PolicyDefinition>パラメーター
- policyDefinitionName
-
string
作成するポリシー定義の名前。
- parameters
- PolicyDefinition
ポリシー定義のプロパティ。
options パラメーター。
戻り値
Promise<PolicyDefinition>
createOrUpdateAtManagementGroup(string, string, PolicyDefinition, PolicyDefinitionsCreateOrUpdateAtManagementGroupOptionalParams)
この操作により、指定された管理グループ内のポリシー定義が、指定された名前で作成または更新されます。
function createOrUpdateAtManagementGroup(policyDefinitionName: string, managementGroupId: string, parameters: PolicyDefinition, options?: PolicyDefinitionsCreateOrUpdateAtManagementGroupOptionalParams): Promise<PolicyDefinition>パラメーター
- policyDefinitionName
-
string
作成するポリシー定義の名前。
- managementGroupId
-
string
管理グループの ID。
- parameters
- PolicyDefinition
ポリシー定義のプロパティ。
options パラメーター。
戻り値
Promise<PolicyDefinition>
delete(string, PolicyDefinitionsDeleteOptionalParams)
この操作により、指定されたサブスクリプション内のポリシー定義が、指定された名前で削除されます。
function delete(policyDefinitionName: string, options?: PolicyDefinitionsDeleteOptionalParams): Promise<void>パラメーター
- policyDefinitionName
-
string
削除するポリシー定義の名前。
options パラメーター。
戻り値
Promise<void>
deleteAtManagementGroup(string, string, PolicyDefinitionsDeleteAtManagementGroupOptionalParams)
この操作により、指定された名前の特定の管理グループ内のポリシー定義が削除されます。
function deleteAtManagementGroup(policyDefinitionName: string, managementGroupId: string, options?: PolicyDefinitionsDeleteAtManagementGroupOptionalParams): Promise<void>パラメーター
- policyDefinitionName
-
string
削除するポリシー定義の名前。
- managementGroupId
-
string
管理グループの ID。
options パラメーター。
戻り値
Promise<void>
get(string, PolicyDefinitionsGetOptionalParams)
この操作により、指定された名前の指定されたサブスクリプション内のポリシー定義が取得されます。
function get(policyDefinitionName: string, options?: PolicyDefinitionsGetOptionalParams): Promise<PolicyDefinition>パラメーター
- policyDefinitionName
-
string
取得するポリシー定義の名前。
options パラメーター。
戻り値
Promise<PolicyDefinition>
getAtManagementGroup(string, string, PolicyDefinitionsGetAtManagementGroupOptionalParams)
この操作により、指定された名前の特定の管理グループ内のポリシー定義が取得されます。
function getAtManagementGroup(policyDefinitionName: string, managementGroupId: string, options?: PolicyDefinitionsGetAtManagementGroupOptionalParams): Promise<PolicyDefinition>パラメーター
- policyDefinitionName
-
string
取得するポリシー定義の名前。
- managementGroupId
-
string
管理グループの ID。
options パラメーター。
戻り値
Promise<PolicyDefinition>
getBuiltIn(string, PolicyDefinitionsGetBuiltInOptionalParams)
この操作は、指定された名前の組み込みポリシー定義を取得します。
function getBuiltIn(policyDefinitionName: string, options?: PolicyDefinitionsGetBuiltInOptionalParams): Promise<PolicyDefinition>パラメーター
- policyDefinitionName
-
string
取得する組み込みポリシー定義の名前。
options パラメーター。
戻り値
Promise<PolicyDefinition>
list(PolicyDefinitionsListOptionalParams)
この操作により、指定したサブスクリプション内のすべてのポリシー定義の一覧が取得され、オプションの指定された$filterと一致します。 $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} と一致するすべてのポリシー定義のみが含まれます。
function list(options?: PolicyDefinitionsListOptionalParams): PagedAsyncIterableIterator<PolicyDefinition, PolicyDefinition[], PageSettings>パラメーター
options パラメーター。
戻り値
listBuiltIn(PolicyDefinitionsListBuiltInOptionalParams)
この操作により、オプションの指定した$filterに一致するすべての組み込みポリシー定義の一覧が取得されます。 $filter='policyType -eq {value}' が指定されている場合、返されるリストには、型が {value} と一致するすべての組み込みポリシー定義のみが含まれます。 使用可能な policyType 値は、NotSpecified、BuiltIn、Custom、Static です。 $filter='category -eq {value}' が指定されている場合、返されるリストには、カテゴリが {value} と一致するすべての組み込みポリシー定義のみが含まれます。
function listBuiltIn(options?: PolicyDefinitionsListBuiltInOptionalParams): PagedAsyncIterableIterator<PolicyDefinition, PolicyDefinition[], PageSettings>パラメーター
options パラメーター。
戻り値
listByManagementGroup(string, PolicyDefinitionsListByManagementGroupOptionalParams)
この操作は、指定された管理グループ内のすべてのポリシー定義の一覧を取得します。これは、省略可能な特定の$filterと一致します。 $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} と一致するすべてのポリシー定義のみが含まれます。
function listByManagementGroup(managementGroupId: string, options?: PolicyDefinitionsListByManagementGroupOptionalParams): PagedAsyncIterableIterator<PolicyDefinition, PolicyDefinition[], PageSettings>パラメーター
- managementGroupId
-
string
管理グループの ID。
options パラメーター。