Sdílet prostřednictvím

ResourcesListOptionalParams interface

  • Reference
Balíček:
@azure/arm-resources

Volitelné parametry.

Extends
OperationOptions

Vlastnosti

expand

Čárkami oddělený seznam dalších vlastností, které se mají zahrnout do odpovědi. Platné hodnoty zahrnují createdTime, changedTime a provisioningState. Například $expand=createdTime,changedTime.
filter

Filtr, který se má použít pro operaci.

Operátory porovnání filtrů zahrnují eq (rovná se) a ne (nerovná se) a mohou být použity s následujícími vlastnostmi: location, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/versiona plan/promotionCode.

Pokud chcete například filtrovat podle typu prostředku, použijte $filter=resourceType eq 'Microsoft.Network/virtualNetworks'


substringof(value, property) lze použít k filtrování podřetěžců následujících aktuálně podporovaných vlastností: name a resourceGroup

Pokud chcete například získat všechny prostředky s ukázkou kdekoli v názvu prostředku, použijte $filter=substringof('demo', name)

Více operací podřetězece lze také kombinovat pomocí operátorů and/or.

Mějte na paměti, že při použití filtru nemusí být kompatibilní také jakýkoli zkrácený počet výsledků dotazovaných prostřednictvím $top.


Prostředky je možné filtrovat podle názvů značek a hodnot. Pokud chcete například filtrovat název a hodnotu značky, použijte $filter=tagName eq 'tag1' and tagValue eq 'Value1'. Všimněte si, že když jsou prostředky filtrovány podle názvu značky a hodnoty, původní značky pro každý prostředek nebudou ve výsledcích vráceny. Seznam dalších vlastností dotazovaných prostřednictvím $expand nemusí být při filtrování podle názvů nebo hodnot značek kompatibilní.

Pouze pro názvy značek lze prostředky filtrovat pomocí předpony pomocí následující syntaxe: $filter=startswith(tagName, 'depart'). Tento dotaz vrátí všechny prostředky s názvem značky s předponou depart fráze (tj.department, departureDate, departureTimeatd.)


Všimněte si, že některé vlastnosti lze kombinovat při filtrování prostředků, které zahrnují následující: substringof() and/or resourceType, plan and plan/publisher and plan/namea identity and identity/principalId.
top

Počet výsledků, které se mají vrátit. Pokud se předá hodnota null, vrátí všechny prostředky.

Zděděné vlastnosti

abortSignal

Signál, který lze použít k přerušení požadavků.
onResponse

Funkce, která se má volat při každém přijetí odpovědi ze serveru při provádění požadované operace. Může se volat vícekrát.
requestOptions

Možnosti používané při vytváření a odesílání požadavků HTTP pro tuto operaci
serializerOptions

Možnosti přepsání serializace/de-serializace chování.
tracingOptions

Možnosti používané při povolení trasování

Podrobnosti vlastnosti

expand

Čárkami oddělený seznam dalších vlastností, které se mají zahrnout do odpovědi. Platné hodnoty zahrnují createdTime, changedTime a provisioningState. Například $expand=createdTime,changedTime.

expand?: string

Hodnota vlastnosti

string

filter

Filtr, který se má použít pro operaci.

Operátory porovnání filtrů zahrnují eq (rovná se) a ne (nerovná se) a mohou být použity s následujícími vlastnostmi: location, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/versiona plan/promotionCode.

Pokud chcete například filtrovat podle typu prostředku, použijte $filter=resourceType eq 'Microsoft.Network/virtualNetworks'


substringof(value, property) lze použít k filtrování podřetěžců následujících aktuálně podporovaných vlastností: name a resourceGroup

Pokud chcete například získat všechny prostředky s ukázkou kdekoli v názvu prostředku, použijte $filter=substringof('demo', name)

Více operací podřetězece lze také kombinovat pomocí operátorů and/or.

Mějte na paměti, že při použití filtru nemusí být kompatibilní také jakýkoli zkrácený počet výsledků dotazovaných prostřednictvím $top.


Prostředky je možné filtrovat podle názvů značek a hodnot. Pokud chcete například filtrovat název a hodnotu značky, použijte $filter=tagName eq 'tag1' and tagValue eq 'Value1'. Všimněte si, že když jsou prostředky filtrovány podle názvu značky a hodnoty, původní značky pro každý prostředek nebudou ve výsledcích vráceny. Seznam dalších vlastností dotazovaných prostřednictvím $expand nemusí být při filtrování podle názvů nebo hodnot značek kompatibilní.

Pouze pro názvy značek lze prostředky filtrovat pomocí předpony pomocí následující syntaxe: $filter=startswith(tagName, 'depart'). Tento dotaz vrátí všechny prostředky s názvem značky s předponou depart fráze (tj.department, departureDate, departureTimeatd.)


Všimněte si, že některé vlastnosti lze kombinovat při filtrování prostředků, které zahrnují následující: substringof() and/or resourceType, plan and plan/publisher and plan/namea identity and identity/principalId.

filter?: string

Hodnota vlastnosti

string

top

Počet výsledků, které se mají vrátit. Pokud se předá hodnota null, vrátí všechny prostředky.

top?: number

Hodnota vlastnosti

number

Podrobnosti zděděných vlastností

abortSignal

Signál, který lze použít k přerušení požadavků.

abortSignal?: AbortSignalLike

Hodnota vlastnosti

AbortSignalLike

zděděný z coreClient.OperationOptions.abortSignal

onResponse

Funkce, která se má volat při každém přijetí odpovědi ze serveru při provádění požadované operace. Může se volat vícekrát.

onResponse?: RawResponseCallback

Hodnota vlastnosti

RawResponseCallback

zděděno z coreClient.OperationOptions.onResponse

requestOptions

Možnosti používané při vytváření a odesílání požadavků HTTP pro tuto operaci

requestOptions?: OperationRequestOptions

Hodnota vlastnosti

OperationRequestOptions

zděděné z coreClient.OperationOptions.requestOptions

serializerOptions

Možnosti přepsání serializace/de-serializace chování.

serializerOptions?: SerializerOptions

Hodnota vlastnosti

SerializerOptions

zděděno z coreClient.OperationOptions.serializerOptions

tracingOptions

Možnosti používané při povolení trasování

tracingOptions?: OperationTracingOptions

Hodnota vlastnosti

OperationTracingOptions

zděděno z coreClient.OperationOptions.tracingOptions