ResourcesListByResourceGroupOptionalParams interface
省略可能なパラメーター。
- Extends
プロパティ
expand | 応答に含める追加のプロパティのコンマ区切りのリスト。 有効な値には、、 |
filter | 操作に適用するフィルター。 |
top | 返される結果の数。 null が渡された場合は、すべてのリソースを返します。 |
継承されたプロパティ
abort |
要求を中止するために使用できるシグナル。 |
on |
要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。 |
request |
この操作の HTTP 要求を作成および送信するときに使用されるオプション。 |
serializer |
シリアル化/シリアル化解除の動作をオーバーライドするオプション。 |
tracing |
トレースが有効な場合に使用されるオプション。 |
プロパティの詳細
expand
応答に含める追加のプロパティのコンマ区切りのリスト。 有効な値には、、changedTime
および がprovisioningState
含まれますcreatedTime
。 たとえば、「 $expand=createdTime,changedTime
」のように入力します。
expand?: string
プロパティ値
string
filter
操作に適用するフィルター。
eq (equals) または ne (not equals) に使用できるプロパティは、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) を使用します。
演算子や 演算子を追加することで、複数の部分文字列をリンクできます。
タグの名前と値でフィルター処理できます。 たとえば、タグ名と値をフィルター処理するには、$filter=tagName eq 'tag1' と tagValue eq 'Value1' を使用します。 タグ名と値でフィルター処理する場合、各リソースのタグは結果に返されません。
フィルター処理時に一部のプロパティを一緒に使用できます。 使用できる組み合わせは、substringof や resourceType、plan と plan/publisher、plan/name、identity と identity/principalId です。
filter?: string
プロパティ値
string
top
返される結果の数。 null が渡された場合は、すべてのリソースを返します。
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 から継承