EntitiesListNextOptionalParams interface

套件:

@azure/arm-managementgroups

選用參數。

Extends

OperationOptions

屬性

cacheControl	指出要求是否應該使用任何快取。 使用 'no-cache' 值填入標頭，以略過現有的快取。
filter	篩選參數可讓您篩選名稱或顯示名稱欄位。 您可以檢查名稱欄位 (是否相等，例如名稱 eq '{entityName}') ，而且您可以在名稱或顯示名稱 (欄位上檢查子字串，例如，包含 (名稱、'{substringToSearch}') 、包含 (displayName、'{substringToSearch') ) 。 請注意，'{entityName}' 和 '{substringToSearch}' 欄位不區分大小寫。
groupName	允許取得實體呼叫的篩選，將焦點放在特定群組 (，也就是 「$filter=name eq 'groupName'」)
search	$search參數會與 $filter 參數搭配使用，根據傳入的參數傳回三個不同的輸出。 使用 $search=AllowedParents 時，API 會傳回要求之實體能夠依使用者權限所決定的所有群組的實體資訊。 使用 $search=AllowedChildren 時，API 會傳回可新增為所要求實體子系之所有實體的實體資訊。 使用 $search=ParentAndFirstLevelChildren 時，API 會傳回使用者透過其中一個子系直接存取或間接存取的父系和第一層子系。 使用 $search=ParentOnly 時，只有當使用者至少有一個群組子系的存取權時，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 元素的值會包含 token 參數，指定後續呼叫要使用的起點。
top	擷取結果時要傳回的專案數。 傳入此檔案將會覆寫$skipToken。
view	檢視參數可讓用戶端篩選 getEntities 呼叫所傳回的資料類型。

繼承的屬性

abortSignal	可用來中止要求的訊號。
onResponse	每次從伺服器收到回應時，要呼叫的函式，同時執行要求的作業。 可以多次呼叫。
requestOptions	建立和傳送此作業之 HTTP 要求時所使用的選項。
serializerOptions	覆寫序列化/取消序列化行為的選項。
tracingOptions	啟用追蹤時所使用的選項。

屬性詳細資料

cacheControl

指出要求是否應該使用任何快取。 使用 'no-cache' 值填入標頭，以略過現有的快取。

cacheControl?: string

屬性值

string

filter

篩選參數可讓您篩選名稱或顯示名稱欄位。 您可以檢查名稱欄位 (是否相等，例如名稱 eq '{entityName}') ，而且您可以在名稱或顯示名稱 (欄位上檢查子字串，例如，包含 (名稱、'{substringToSearch}') 、包含 (displayName、'{substringToSearch') ) 。 請注意，'{entityName}' 和 '{substringToSearch}' 欄位不區分大小寫。

filter?: string

屬性值

string

groupName

允許取得實體呼叫的篩選，將焦點放在特定群組 (，也就是 「$filter=name eq 'groupName'」)

groupName?: string

屬性值

string

search

$search參數會與 $filter 參數搭配使用，根據傳入的參數傳回三個不同的輸出。 使用 $search=AllowedParents 時，API 會傳回要求之實體能夠依使用者權限所決定的所有群組的實體資訊。 使用 $search=AllowedChildren 時，API 會傳回可新增為所要求實體子系之所有實體的實體資訊。 使用 $search=ParentAndFirstLevelChildren 時，API 會傳回使用者透過其中一個子系直接存取或間接存取的父系和第一層子系。 使用 $search=ParentOnly 時，只有當使用者至少有一個群組子系的存取權時，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 元素的值會包含 token 參數，指定後續呼叫要使用的起點。

skiptoken?: string

屬性值

string

top

擷取結果時要傳回的專案數。 傳入此檔案將會覆寫$skipToken。

top?: number

屬性值

number

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