ResourcesListOptionalParams interface
Valfria parametrar.
- Extends
Egenskaper
expand | Kommaavgränsad lista över ytterligare egenskaper som ska ingå i svaret. Giltiga värden är |
filter | Filtret som ska tillämpas på åtgärden. |
top | Antalet resultat som ska returneras. Om null skickas returneras alla resurser. |
Ärvda egenskaper
abort |
Den signal som kan användas för att avbryta begäranden. |
on |
En funktion som ska anropas varje gång ett svar tas emot från servern när den begärda åtgärden utförs. Kan anropas flera gånger. |
request |
Alternativ som används när du skapar och skickar HTTP-begäranden för den här åtgärden. |
serializer |
Alternativ för att åsidosätta serialiserings-/avserialiseringsbeteende. |
tracing |
Alternativ som används när spårning är aktiverat. |
Egenskapsinformation
expand
Kommaavgränsad lista över ytterligare egenskaper som ska ingå i svaret. Giltiga värden är createdTime
, changedTime
och provisioningState
. Till exempel $expand=createdTime,changedTime
.
expand?: string
Egenskapsvärde
string
filter
Filtret som ska tillämpas på åtgärden.
Filterjämförelseoperatorer inkluderar eq
(lika med) och ne
(inte lika med) och kan användas med följande egenskaper: location
, , name
resourceType
, resourceGroup
, identity
, identity/principalId
, plan
, plan/publisher
, plan/product
plan/name
, , plan/version
och plan/promotionCode
.
Om du till exempel vill filtrera efter en resurstyp använder du $filter=resourceType eq 'Microsoft.Network/virtualNetworks'
substringof(value, property)
kan användas för att filtrera efter delsträngar av följande egenskaper som stöds för närvarande: name
och resourceGroup
Om du till exempel vill hämta alla resurser med "demo" var som helst i resursnamnet använder du $filter=substringof('demo', name)
Flera delsträngsåtgärder kan också kombineras med operatorer and
/or
.
Observera att ett trunkerat antal resultat som efterfrågas via $top
kanske inte heller är kompatibelt när du använder ett filter.
Resurser kan filtreras efter taggnamn och värden. Om du till exempel vill filtrera efter ett taggnamn och -värde använder du $filter=tagName eq 'tag1' and tagValue eq 'Value1'
. Observera att när resurser filtreras efter taggnamn och värde returneras inte de ursprungliga taggarna för varje resurs i resultatet. Alla listor över ytterligare egenskaper som efterfrågas via $expand
kanske inte heller är kompatibla när du filtrerar efter taggnamn/värden.
Endast för taggnamn kan resurser filtreras efter prefix med hjälp av följande syntax: $filter=startswith(tagName, 'depart')
. Den här frågan returnerar alla resurser med ett taggnamn som föregås av frasen depart
(t.ex. departureDate
department
, departureTime
osv.)
Observera att vissa egenskaper kan kombineras vid filtrering av resurser, bland annat följande: substringof() and/or resourceType
, plan and plan/publisher and plan/name
och identity and identity/principalId
.
filter?: string
Egenskapsvärde
string
top
Antalet resultat som ska returneras. Om null skickas returneras alla resurser.
top?: number
Egenskapsvärde
number
Information om ärvda egenskaper
abortSignal
Den signal som kan användas för att avbryta begäranden.
abortSignal?: AbortSignalLike
Egenskapsvärde
Ärvd från coreClient.OperationOptions.abortSignal
onResponse
En funktion som ska anropas varje gång ett svar tas emot från servern när den begärda åtgärden utförs. Kan anropas flera gånger.
onResponse?: RawResponseCallback
Egenskapsvärde
Ärvd från coreClient.OperationOptions.onResponse
requestOptions
Alternativ som används när du skapar och skickar HTTP-begäranden för den här åtgärden.
requestOptions?: OperationRequestOptions
Egenskapsvärde
Ärvt från coreClient.OperationOptions.requestOptions
serializerOptions
Alternativ för att åsidosätta serialiserings-/avserialiseringsbeteende.
serializerOptions?: SerializerOptions
Egenskapsvärde
Ärvt från coreClient.OperationOptions.serializerOptions
tracingOptions
Alternativ som används när spårning är aktiverat.
tracingOptions?: OperationTracingOptions
Egenskapsvärde
Ärvt från coreClient.OperationOptions.tracingOptions