ResourcesListOptionalParams interface

包:

@azure/arm-resources

可选参数。

扩展

OperationOptions

属性

expand	要包含在响应中的其他属性的逗号分隔列表。 有效值包括 createdTime、changedTime 和 provisioningState。 例如，$expand=createdTime,changedTime。
filter	要应用于作的筛选器。 筛选器比较运算符包括 eq（equals）和 ne（不相等），可用于以下属性：location、resourceType、name、resourceGroup、identity、identity/principalId、plan、plan/publisher、plan/product、plan/name、plan/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 标记名称的所有资源（即department、departureDate、departureTime等） 请注意，筛选资源时可以组合某些属性，其中包括：substringof() and/or resourceType、plan and plan/publisher and plan/name和 identity and identity/principalId。
top	如果使用此 API 的分页版本，则每个页面的建议数。

继承属性

abortSignal	可用于中止请求的信号。
onResponse	在执行请求的作时，每次从服务器接收响应时调用的函数。 可以多次调用。
requestOptions	为此作创建和发送 HTTP 请求时使用的选项。
serializerOptions	用于替代序列化/取消序列化行为的选项。
tracingOptions	启用跟踪时使用的选项。

属性详细信息

expand

要包含在响应中的其他属性的逗号分隔列表。 有效值包括 createdTime、changedTime 和 provisioningState。 例如，$expand=createdTime,changedTime。

expand?: string

属性值

string

filter

要应用于作的筛选器。

筛选器比较运算符包括 eq（equals）和 ne（不相等），可用于以下属性：location、resourceType、name、resourceGroup、identity、identity/principalId、plan、plan/publisher、plan/product、plan/name、plan/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 标记名称的所有资源（即department、departureDate、departureTime等）


请注意，筛选资源时可以组合某些属性，其中包括：substringof() and/or resourceType、plan and plan/publisher and plan/name和 identity and identity/principalId。

filter?: string

属性值

string

top

如果使用此 API 的分页版本，则每个页面的建议数。

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