ResourcesListOptionalParams interface

Pakket:

@azure/arm-resources

Optionele parameters.

Uitbreiding

OperationOptions

Eigenschappen

expand	Door komma's gescheiden lijst met aanvullende eigenschappen die moeten worden opgenomen in het antwoord. Geldige waarden zijn onder andere createdTime, changedTime en provisioningState. Bijvoorbeeld $expand=createdTime,changedTime.
filter	Het filter dat moet worden toegepast op de bewerking. Filtervergelijkingsoperatoren bevatten eq (is gelijk aan) en ne (niet gelijk aan) en kunnen worden gebruikt met de volgende eigenschappen: location, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/versionen plan/promotionCode. Als u bijvoorbeeld wilt filteren op een resourcetype, gebruikt u $filter=resourceType eq 'Microsoft.Network/virtualNetworks' substringof(value, property) kan worden gebruikt om te filteren op subtekenreeksen van de volgende eigenschappen die momenteel worden ondersteund: name en resourceGroup Als u bijvoorbeeld alle resources met 'demo' overal in de resourcenaam wilt ophalen, gebruikt u $filter=substringof('demo', name) Meerdere subtekenreeksbewerkingen kunnen ook worden gecombineerd met behulp van and/or operators. Houd er rekening mee dat een afgekapt aantal resultaten dat via $top wordt opgevraagd, mogelijk ook niet compatibel is bij het gebruik van een filter. Resources kunnen worden gefilterd op tagnamen en -waarden. Als u bijvoorbeeld wilt filteren op een tagnaam en -waarde, gebruikt u $filter=tagName eq 'tag1' and tagValue eq 'Value1'. Houd er rekening mee dat wanneer resources worden gefilterd op tagnaam en -waarde, de oorspronkelijke tags voor elke resource niet worden geretourneerd in de resultaten. Een lijst met aanvullende eigenschappen die via $expand worden opgevraagd, is mogelijk ook niet compatibel wanneer u filtert op tagnamen/-waarden. Alleen voor tagnamen kunnen resources worden gefilterd op voorvoegsel met behulp van de volgende syntaxis: $filter=startswith(tagName, 'depart'). Deze query retourneert alle resources met een tagnaam voorafgegaan door de woordgroep depart (bijvoorbeelddepartment, departureDate, departureTime, enzovoort) Houd er rekening mee dat sommige eigenschappen kunnen worden gecombineerd bij het filteren van resources, zoals het volgende: substringof() and/or resourceType, plan and plan/publisher and plan/nameen identity and identity/principalId.
top	Het aantal aanbevelingen per pagina als er een paginaversie van deze API wordt gebruikt.

Overgenomen eigenschappen

abortSignal	Het signaal dat kan worden gebruikt om aanvragen af te breken.
onResponse	Een functie die telkens wordt aangeroepen wanneer een antwoord van de server wordt ontvangen tijdens het uitvoeren van de aangevraagde bewerking. Kan meerdere keren worden aangeroepen.
requestOptions	Opties die worden gebruikt bij het maken en verzenden van HTTP-aanvragen voor deze bewerking.
serializerOptions	Opties voor het overschrijven van serialisatie/deserialisatiegedrag.
tracingOptions	Opties die worden gebruikt wanneer tracering is ingeschakeld.

Eigenschapdetails

expand

Door komma's gescheiden lijst met aanvullende eigenschappen die moeten worden opgenomen in het antwoord. Geldige waarden zijn onder andere createdTime, changedTime en provisioningState. Bijvoorbeeld $expand=createdTime,changedTime.

expand?: string

Waarde van eigenschap

string

filter

Het filter dat moet worden toegepast op de bewerking.

Filtervergelijkingsoperatoren bevatten eq (is gelijk aan) en ne (niet gelijk aan) en kunnen worden gebruikt met de volgende eigenschappen: location, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/versionen plan/promotionCode.

Als u bijvoorbeeld wilt filteren op een resourcetype, gebruikt u $filter=resourceType eq 'Microsoft.Network/virtualNetworks'


substringof(value, property) kan worden gebruikt om te filteren op subtekenreeksen van de volgende eigenschappen die momenteel worden ondersteund: name en resourceGroup

Als u bijvoorbeeld alle resources met 'demo' overal in de resourcenaam wilt ophalen, gebruikt u $filter=substringof('demo', name)

Meerdere subtekenreeksbewerkingen kunnen ook worden gecombineerd met behulp van and/or operators.

Houd er rekening mee dat een afgekapt aantal resultaten dat via $top wordt opgevraagd, mogelijk ook niet compatibel is bij het gebruik van een filter.


Resources kunnen worden gefilterd op tagnamen en -waarden. Als u bijvoorbeeld wilt filteren op een tagnaam en -waarde, gebruikt u $filter=tagName eq 'tag1' and tagValue eq 'Value1'. Houd er rekening mee dat wanneer resources worden gefilterd op tagnaam en -waarde, de oorspronkelijke tags voor elke resource niet worden geretourneerd in de resultaten. Een lijst met aanvullende eigenschappen die via $expand worden opgevraagd, is mogelijk ook niet compatibel wanneer u filtert op tagnamen/-waarden.

Alleen voor tagnamen kunnen resources worden gefilterd op voorvoegsel met behulp van de volgende syntaxis: $filter=startswith(tagName, 'depart'). Deze query retourneert alle resources met een tagnaam voorafgegaan door de woordgroep depart (bijvoorbeelddepartment, departureDate, departureTime, enzovoort)


Houd er rekening mee dat sommige eigenschappen kunnen worden gecombineerd bij het filteren van resources, zoals het volgende: substringof() and/or resourceType, plan and plan/publisher and plan/nameen identity and identity/principalId.

filter?: string

Waarde van eigenschap

string

top

Het aantal aanbevelingen per pagina als er een paginaversie van deze API wordt gebruikt.

top?: number

Waarde van eigenschap

number

Details van overgenomen eigenschap

abortSignal

Het signaal dat kan worden gebruikt om aanvragen af te breken.

abortSignal?: AbortSignalLike

Waarde van eigenschap

AbortSignalLike

overgenomen van coreClient.OperationOptions.abortSignal

onResponse

Een functie die telkens wordt aangeroepen wanneer een antwoord van de server wordt ontvangen tijdens het uitvoeren van de aangevraagde bewerking. Kan meerdere keren worden aangeroepen.

onResponse?: RawResponseCallback

Waarde van eigenschap

RawResponseCallback

overgenomen van coreClient.OperationOptions.onResponse

requestOptions

Opties die worden gebruikt bij het maken en verzenden van HTTP-aanvragen voor deze bewerking.

requestOptions?: OperationRequestOptions

Waarde van eigenschap

OperationRequestOptions

overgenomen van coreClient.OperationOptions.requestOptions

serializerOptions

Opties voor het overschrijven van serialisatie/deserialisatiegedrag.

serializerOptions?: SerializerOptions

Waarde van eigenschap

SerializerOptions

overgenomen van coreClient.OperationOptions.serializerOptions

tracingOptions

Opties die worden gebruikt wanneer tracering is ingeschakeld.

tracingOptions?: OperationTracingOptions

Waarde van eigenschap

OperationTracingOptions

overgenomen van coreClient.OperationOptions.tracingOptions