EntitiesOperationsExtensions.ListAsync メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
認証済みユーザーのすべてのエンティティ (管理グループ、サブスクリプションなど) を一覧表示します。
public static System.Threading.Tasks.Task<Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.ManagementGroups.Models.EntityInfo>> ListAsync (this Microsoft.Azure.Management.ManagementGroups.IEntitiesOperations operations, string skiptoken = default, int? skip = default, int? top = default, string select = default, string search = default, string filter = default, string view = default, string groupName = default, string cacheControl = "no-cache", System.Threading.CancellationToken cancellationToken = default);static member ListAsync : Microsoft.Azure.Management.ManagementGroups.IEntitiesOperations * string * Nullable<int> * Nullable<int> * string * string * string * string * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.ManagementGroups.Models.EntityInfo>><Extension()>
Public Function ListAsync (operations As IEntitiesOperations, Optional skiptoken As String = Nothing, Optional skip As Nullable(Of Integer) = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional select As String = Nothing, Optional search As String = Nothing, Optional filter As String = Nothing, Optional view As String = Nothing, Optional groupName As String = Nothing, Optional cacheControl As String = "no-cache", Optional cancellationToken As CancellationToken = Nothing) As Task(Of IPage(Of EntityInfo))パラメーター
- operations
- IEntitiesOperations
この拡張メソッドの操作グループ。
- skiptoken
- String
ページ継続トークンは、前の操作で部分的な結果が返された場合にのみ使用されます。 前の応答に nextLink 要素が含まれている場合、nextLink 要素の値には、後続の呼び出しに使用する開始点を指定するトークン パラメーターが含まれます。
- select
- String
このパラメーターは、応答に含めるフィールドを指定します。 名前、DisplayName、Type、ParentDisplayNameChain、ParentChain の任意の組み合わせを含めることができます(例: '$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain')。 指定すると、$select パラメーターは$skipTokenの選択をオーバーライドできます。
- search
- String
$search パラメーターは、渡されたパラメーターに応じて 3 つの異なる出力を返すために、$filter パラメーターと組み合わせて使用されます。 $search=AllowedParents を使用すると、API は、ユーザーのアクセス許可によって決定されたとおりに、要求されたエンティティが親を戻すことができるすべてのグループのエンティティ情報を返します。 $search=AllowedChildren では、API は、要求されたエンティティの子として追加できるすべてのエンティティのエンティティ情報を返します。 $search=ParentAndFirstLevelChildren を使用すると、API は、ユーザーが子孫の 1 つを介して直接アクセスまたは間接アクセスを持つ親および第 1 レベルの子を返します。 $search=ParentOnly では、ユーザーがグループの少なくとも 1 つの子孫にアクセスできる場合、API はグループのみを返します。 $search=ChildrenOnly を指定すると、API は、$filterで指定されたグループ エンティティ情報の最初のレベルの子のみを返します。 結果に表示するには、ユーザーが子エンティティまたはその子孫のいずれかに直接アクセスできる必要があります。 使用できる値は、'AllowedParents'、'AllowedChildren'、'ParentAndFirstLevelChildren'、'ParentOnly'、'ChildrenOnly' です。
- filter
- String
filter パラメーターを使用すると、名前フィールドまたは表示名フィールドをフィルター処理できます。 名前フィールド (例: name eq '{entityName}') に等しいかどうかをチェックできます。また、名前または表示名のフィールド (例: contains(name, '{substringToSearch}') の部分文字列に対してチェックできます。contains(displayName, '{substringToSearch'))。 '{entityName}' フィールドと '{substringToSearch}' フィールドの大文字と小文字は区別されません。
- view
- String
view パラメーターを使用すると、クライアントは getEntities 呼び出しによって返されるデータの種類をフィルター処理できます。 使用できる値は、'FullHierarchy'、'GroupsOnly'、'SubscriptionsOnly'、'Audit' です。
- groupName
- String
get エンティティ呼び出しで特定のグループにフォーカスを設定できるようにするフィルター (つまり、"$filter=name eq 'groupName'")
- cacheControl
- String
要求でキャッシュを利用する必要があるかどうかを示します。 既存のキャッシュをバイパスするには、ヘッダーに "キャッシュなし" 値を設定します。
- cancellationToken
- CancellationToken
キャンセル トークン。
戻り値
適用対象
Azure SDK for .NET