IPolicyDefinitionsOperations.ListByManagementGroupWithHttpMessagesAsync メソッド

  • リファレンス

定義

名前空間:
Microsoft.Azure.Management.ResourceManager
アセンブリ:
Microsoft.Azure.Management.ResourceManager.dll
パッケージ:
Microsoft.Azure.Management.ResourceManager v3.17.4-preview

管理グループ内のポリシー定義を取得する

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.ResourceManager.Models.PolicyDefinition>>> ListByManagementGroupWithHttpMessagesAsync (string managementGroupId, string filter = default, int? top = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);
abstract member ListByManagementGroupWithHttpMessagesAsync : string * string * Nullable<int> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.ResourceManager.Models.PolicyDefinition>>>
Public Function ListByManagementGroupWithHttpMessagesAsync (managementGroupId As String, Optional filter As String = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of IPage(Of PolicyDefinition)))

パラメーター

managementGroupId
String

管理グループの ID。

filter
String

操作に適用するフィルター。 $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
Nullable<Int32>

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

customHeaders
Dictionary<String,List<String>>

要求に追加されるヘッダー。

cancellationToken
CancellationToken

キャンセル トークン。

戻り値

Task<AzureOperationResponse<IPage<PolicyDefinition>>>

例外

CloudException

操作が無効な状態コードを返したときにスローされます

SerializationException

応答を逆シリアル化できない場合にスローされます

ValidationException

必須パラメーターが null の場合にスローされます

注釈

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

適用対象