ResourcesListOptionalParams interface

參考

套件:: @azure/arm-resources

選用參數。

Extends: OperationOptions

屬性

expand	要包含在回應中的其他屬性逗號分隔清單。有效值包括 `createdTime` 、 `changedTime` 和 `provisioningState` 。例如： `$expand=createdTime,changedTime` 。
filter	要套用至作業的篩選準則。篩選比較運算子包括 `eq` (等於) 和 `ne` (不等於) ，而且可以搭配下列屬性使用： `location` 、 `resourceType` 、 `name` 、 `resourceGroup` 、、 `plan/publisheridentity/principalIdidentityplan/productplan/nameplanplan/version` 和。 `plan/promotionCode` 例如，若要依資源類型進行篩選，請使用 `$filter=resourceType eq 'Microsoft.Network/virtualNetworks'` `substringof(value, property)` 可用來篩選下列目前支援之屬性的子字串： `name` 和 `resourceGroup` 例如，若要取得資源名稱中任何位置具有 'demo' 的所有資源，請使用 `$filter=substringof('demo', name)` 您也可以使用 `and`/`or` 運算子來合併多個子字串作業。請注意，使用篩選時，透過查詢 `$top` 的任何截斷結果數目也可能不相容。資源可以依標記名稱和值進行篩選。例如，若要篩選標籤名稱和值，請使用 `$filter=tagName eq 'tag1' and tagValue eq 'Value1'` 。請注意，當資源依標籤名稱和值篩選時，結果中將不會傳回每個資源的原始標記。透過查詢 `$expand` 的其他屬性清單，在依標籤名稱/值進行篩選時，可能也不相容。若為僅限標記名稱，可以使用下列語法，依前置詞篩選資源： `$filter=startswith(tagName, 'depart')` 。此查詢會傳回標籤名稱前面加上片語 `depart` 的所有資源 (，也就是 `departmentdepartureDate` 、 `departureTime` 等) 請注意，篩選資源時可以合併某些屬性，包括下列各項： `substringof() and/or resourceType` 、 `plan and plan/publisher and plan/name` 和 `identity and identity/principalId` 。
top	要傳回的結果數目。如果傳遞 null，則會傳回所有資源。

繼承的屬性

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

屬性詳細資料

expand

要包含在回應中的其他屬性逗號分隔清單。有效值包括 createdTime 、 changedTime 和 provisioningState 。例如： $expand=createdTime,changedTime 。

expand?: string

屬性值

string

filter

要套用至作業的篩選準則。

篩選比較運算子包括 eq (等於) 和 ne (不等於) ，而且可以搭配下列屬性使用： location 、 resourceType 、 name 、 resourceGroup 、、 plan/publisheridentity/principalIdidentityplan/productplan/nameplanplan/version 和。 plan/promotionCode

例如，若要依資源類型進行篩選，請使用 $filter=resourceType eq 'Microsoft.Network/virtualNetworks'

substringof(value, property) 可用來篩選下列目前支援之屬性的子字串： name 和 resourceGroup

例如，若要取得資源名稱中任何位置具有 'demo' 的所有資源，請使用 $filter=substringof('demo', name)

您也可以使用 and/or 運算子來合併多個子字串作業。

請注意，使用篩選時，透過查詢 $top 的任何截斷結果數目也可能不相容。

資源可以依標記名稱和值進行篩選。例如，若要篩選標籤名稱和值，請使用 $filter=tagName eq 'tag1' and tagValue eq 'Value1' 。請注意，當資源依標籤名稱和值篩選時，結果中 將不會傳回每個資源的原始標記。 透過查詢 $expand 的其他屬性清單，在依標籤名稱/值進行篩選時，可能也不相容。

若為僅限標記名稱，可以使用下列語法，依前置詞篩選資源： $filter=startswith(tagName, 'depart') 。此查詢會傳回標籤名稱前面加上片語 depart 的所有資源 (，也就是 departmentdepartureDate 、 departureTime 等)

請注意，篩選資源時可以合併某些屬性，包括下列各項： substringof() and/or resourceType 、 plan and plan/publisher and plan/name 和 identity and identity/principalId 。

filter?: string

屬性值

string

top

要傳回的結果數目。如果傳遞 null，則會傳回所有資源。

top?: number

屬性值

number

繼承的屬性詳細資料

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

共用方式為