ResourcesListOptionalParams interface
省略可能なパラメーター。
- Extends
プロパティ
| expand | 応答に含める追加プロパティのコンマ区切りの一覧。 有効な値には、 |
| filter | 操作に適用するフィルター。 |
| top | この API のページ バージョンが使用されている場合の、ページあたりの推奨事項の数。 |
継承されたプロパティ
| abort |
要求を中止するために使用できるシグナル。 |
| on |
要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。 |
| request |
この操作の HTTP 要求を作成および送信するときに使用されるオプション。 |
| serializer |
シリアル化/シリアル化解除の動作をオーバーライドするオプション。 |
| tracing |
トレースが有効な場合に使用されるオプション。 |
プロパティの詳細
expand
応答に含める追加プロパティのコンマ区切りの一覧。 有効な値には、createdTime、changedTime、および provisioningStateが含まれます。 たとえば、$expand=createdTime,changedTimeします。
expand?: stringプロパティ値
string
filter
操作に適用するフィルター。
フィルター比較演算子には、eq (等しい) および 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プロパティ値
coreClient.OperationOptions.abortSignal から継承
onResponse
要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。
onResponse?: RawResponseCallbackプロパティ値
coreClient.OperationOptions.onResponse から継承
requestOptions
この操作の HTTP 要求を作成および送信するときに使用されるオプション。
requestOptions?: OperationRequestOptionsプロパティ値
coreClient.OperationOptions.requestOptions から継承
serializerOptions
シリアル化/シリアル化解除の動作をオーバーライドするオプション。
serializerOptions?: SerializerOptionsプロパティ値
coreClient.OperationOptions.serializerOptions から継承
tracingOptions
トレースが有効な場合に使用されるオプション。
tracingOptions?: OperationTracingOptionsプロパティ値
coreClient.OperationOptions.tracingOptions から継承