ResourcesListByResourceGroupOptionalParams interface

パッケージ:

@azure/arm-resources

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

Extends

OperationOptions

プロパティ

expand	応答に含める追加プロパティのコンマ区切りの一覧。 有効な値には、createdTime、changedTime、および provisioningStateが含まれます。 たとえば、$expand=createdTime,changedTimeします。
filter	操作に適用するフィルター。 eq (等しい) または ne (等しくない) に使用できるプロパティは、場所、resourceType、名前、resourceGroup、ID、ID/principalId、プラン、プラン/発行元、プラン/製品、プラン/名前、プラン/バージョン、プラン/昇格コードです。 たとえば、リソースの種類でフィルター処理するには、$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、プランとプラン/パブリッシャー、プラン/名前、ID と ID/principalId です。
top	返される結果の数。 null が渡された場合は、すべてのリソースを返します。

継承されたプロパティ

abortSignal	要求を中止するために使用できるシグナル。
onResponse	要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。
requestOptions	この操作の HTTP 要求を作成および送信するときに使用されるオプション。
serializerOptions	シリアル化/シリアル化解除の動作をオーバーライドするオプション。
tracingOptions	トレースが有効な場合に使用されるオプション。

プロパティの詳細

expand

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

expand?: string

プロパティ値

string

filter

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

eq (等しい) または ne (等しくない) に使用できるプロパティは、場所、resourceType、名前、resourceGroup、ID、ID/principalId、プラン、プラン/発行元、プラン/製品、プラン/名前、プラン/バージョン、プラン/昇格コードです。

たとえば、リソースの種類でフィルター処理するには、$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、プランとプラン/パブリッシャー、プラン/名前、ID と ID/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 から継承