EntitiesListOptionalParams interface

パッケージ:

@azure/arm-managementgroups

省略可能なパラメーター。

Extends

OperationOptions

プロパティ

cacheControl	要求がキャッシュを利用する必要があるかどうかを示します。 既存のキャッシュをバイパスするには、ヘッダーに 'no-cache' 値を設定します。
filter	フィルター パラメーターを使用すると、名前フィールドまたは表示名フィールドをフィルター処理できます。 名前フィールドで等しいかどうかを確認できます (例: name eq '{entityName}')、名前フィールドまたは表示名フィールド (例: contains(name, '{substringToSearch}'))、contains(displayName、'{substringToSearch')) の部分文字列を確認できます。 '{entityName}' フィールドと '{substringToSearch}' フィールドは大文字と小文字が区別されずにチェックされることに注意してください。
groupName	エンティティの取得呼び出しが特定のグループにフォーカスできるようにするフィルター (つまり、"$filter=name eq 'groupName'")
search	$search パラメーターは、渡されたパラメーターに応じて 3 つの異なる出力を返すために、$filter パラメーターと組み合わせて使用されます。 $search=AllowedParents を使用すると、API は、要求されたエンティティがユーザーのアクセス許可によって決定されたとおりに親を戻すことができるすべてのグループのエンティティ情報を返します。 $search=AllowedChildren では、API は要求されたエンティティの子として追加できるすべてのエンティティのエンティティ情報を返します。 $search=ParentAndFirstLevelChildren を使用すると、API は、ユーザーが子孫の 1 つを介して直接アクセスまたは間接アクセス権を持つ子の親と第 1 レベルを返します。 $search=ParentOnly では、ユーザーがグループの少なくとも 1 つの子孫にアクセスできる場合、API はグループのみを返します。 $search=ChildrenOnly では、API は、$filterで指定されたグループ エンティティ情報の子の最初のレベルのみを返します。 結果に表示するには、ユーザーが子エンティティまたは子エンティティの子孫のいずれかに直接アクセスできる必要があります。
select	このパラメーターは、応答に含めるフィールドを指定します。 Name、DisplayName、Type、ParentDisplayNameChain、ParentChain の任意の組み合わせを含めることができます(例: '$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain')。 指定すると、$select パラメーターは、$skipTokenで select をオーバーライドできます。
skip	結果を取得するときにスキップするエンティティの数。 これを渡すと、$skipTokenがオーバーライドされます。
skiptoken	ページ継続トークンは、前の操作で部分的な結果が返された場合にのみ使用されます。 前の応答に nextLink 要素が含まれている場合、nextLink 要素の値には、後続の呼び出しに使用する開始点を指定するトークン パラメーターが含まれます。
top	結果を取得するときに返す要素の数。 これを渡すと、$skipTokenがオーバーライドされます。
view	view パラメーターを使用すると、クライアントは getEntities 呼び出しによって返されるデータの型をフィルター処理できます。

継承されたプロパティ

abortSignal	要求を中止するために使用できるシグナル。
onResponse	要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。
requestOptions	この操作の HTTP 要求を作成および送信するときに使用されるオプション。
serializerOptions	シリアル化/シリアル化解除の動作をオーバーライドするオプション。
tracingOptions	トレースが有効な場合に使用されるオプション。

プロパティの詳細

cacheControl

要求がキャッシュを利用する必要があるかどうかを示します。 既存のキャッシュをバイパスするには、ヘッダーに 'no-cache' 値を設定します。

cacheControl?: string

プロパティ値

string

filter

フィルター パラメーターを使用すると、名前フィールドまたは表示名フィールドをフィルター処理できます。 名前フィールドで等しいかどうかを確認できます (例: name eq '{entityName}')、名前フィールドまたは表示名フィールド (例: contains(name, '{substringToSearch}'))、contains(displayName、'{substringToSearch')) の部分文字列を確認できます。 '{entityName}' フィールドと '{substringToSearch}' フィールドは大文字と小文字が区別されずにチェックされることに注意してください。

filter?: string

プロパティ値

string

groupName

エンティティの取得呼び出しが特定のグループにフォーカスできるようにするフィルター (つまり、"$filter=name eq 'groupName'")

groupName?: string

プロパティ値

string

search

$search パラメーターは、渡されたパラメーターに応じて 3 つの異なる出力を返すために、$filter パラメーターと組み合わせて使用されます。 $search=AllowedParents を使用すると、API は、要求されたエンティティがユーザーのアクセス許可によって決定されたとおりに親を戻すことができるすべてのグループのエンティティ情報を返します。 $search=AllowedChildren では、API は要求されたエンティティの子として追加できるすべてのエンティティのエンティティ情報を返します。 $search=ParentAndFirstLevelChildren を使用すると、API は、ユーザーが子孫の 1 つを介して直接アクセスまたは間接アクセス権を持つ子の親と第 1 レベルを返します。 $search=ParentOnly では、ユーザーがグループの少なくとも 1 つの子孫にアクセスできる場合、API はグループのみを返します。 $search=ChildrenOnly では、API は、$filterで指定されたグループ エンティティ情報の子の最初のレベルのみを返します。 結果に表示するには、ユーザーが子エンティティまたは子エンティティの子孫のいずれかに直接アクセスできる必要があります。

search?: string

プロパティ値

string

select

このパラメーターは、応答に含めるフィールドを指定します。 Name、DisplayName、Type、ParentDisplayNameChain、ParentChain の任意の組み合わせを含めることができます(例: '$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain')。 指定すると、$select パラメーターは、$skipTokenで select をオーバーライドできます。

select?: string

プロパティ値

string

skip

結果を取得するときにスキップするエンティティの数。 これを渡すと、$skipTokenがオーバーライドされます。

skip?: number

プロパティ値

number

skiptoken

ページ継続トークンは、前の操作で部分的な結果が返された場合にのみ使用されます。 前の応答に nextLink 要素が含まれている場合、nextLink 要素の値には、後続の呼び出しに使用する開始点を指定するトークン パラメーターが含まれます。

skiptoken?: string

プロパティ値

string

top

結果を取得するときに返す要素の数。 これを渡すと、$skipTokenがオーバーライドされます。

top?: number

プロパティ値

number

view

view パラメーターを使用すると、クライアントは getEntities 呼び出しによって返されるデータの型をフィルター処理できます。

view?: string

プロパティ値

string

継承されたプロパティの詳細

abortSignal

要求を中止するために使用できるシグナル。

abortSignal?: AbortSignalLike

プロパティ値

AbortSignalLike

coreClient.OperationOptions.abortSignal から継承

onResponse

要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。

onResponse?: RawResponseCallback

プロパティ値

RawResponseCallback

coreClient.OperationOptions.onResponse から継承

requestOptions

この操作の HTTP 要求を作成および送信するときに使用されるオプション。

requestOptions?: OperationRequestOptions

プロパティ値

OperationRequestOptions

coreClient.OperationOptions.requestOptions から継承

serializerOptions

シリアル化/シリアル化解除の動作をオーバーライドするオプション。

serializerOptions?: SerializerOptions

プロパティ値

SerializerOptions

coreClient.OperationOptions.serializerOptions から継承

tracingOptions

トレースが有効な場合に使用されるオプション。

tracingOptions?: OperationTracingOptions

プロパティ値

OperationTracingOptions

coreClient.OperationOptions.tracingOptions から継承