次の方法で共有

ResourcesListOptionalParams interface

  • リファレンス
パッケージ:
@azure/arm-resources

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

Extends
OperationOptions

プロパティ

expand

応答に含める追加のプロパティのコンマ区切りの一覧。 有効な値には、 と changedTime がprovisioningState含まれますcreatedTime。 たとえば、「 $expand=createdTime,changedTime 」のように入力します。
filter

操作に適用するフィルター。

フィルター比較演算子には (等しい) と ne (等しくない) が含eqまれており、 の各プロパティresourceTypeidentityresourceGroupidentity/principalIdplannamelocationplan/productplan/nameplan/publisherplan/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 (departmentdepartureDatedepartureTime、、など) でプレフィックスが付いたタグ名を持つすべてのリソースを返します。


リソースをフィルター処理するときに、一部のプロパティを組み合わせることができることに注意してくださいsubstringof() and/or resourceType。これには、、 plan and plan/publisher and plan/nameidentity and identity/principalIdが含まれます。
top

返される結果の数。 null が渡された場合は、すべてのリソースを返します。

継承されたプロパティ

abortSignal

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

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

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

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

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

プロパティの詳細

expand

応答に含める追加のプロパティのコンマ区切りの一覧。 有効な値には、 と changedTime がprovisioningState含まれますcreatedTime。 たとえば、「 $expand=createdTime,changedTime 」のように入力します。

expand?: string

プロパティ値

string

filter

操作に適用するフィルター。

フィルター比較演算子には (等しい) と ne (等しくない) が含eqまれており、 の各プロパティresourceTypeidentityresourceGroupidentity/principalIdplannamelocationplan/productplan/nameplan/publisherplan/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 (departmentdepartureDatedepartureTime、、など) でプレフィックスが付いたタグ名を持つすべてのリソースを返します。


リソースをフィルター処理するときに、一部のプロパティを組み合わせることができることに注意してくださいsubstringof() and/or resourceType。これには、、 plan and plan/publisher and plan/nameidentity 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