ClientGroupsListByNamespaceOptionalParams interface

Pakket:

@azure/arm-eventgrid

Optionele parameters.

Uitbreiding

OperationOptions

Eigenschappen

filter

De query die wordt gebruikt om de zoekresultaten te filteren met behulp van de OData-syntaxis. Filteren is alleen toegestaan voor de eigenschap 'name' en met een beperkt aantal OData-bewerkingen. Deze bewerkingen zijn: de functie 'contains' en de volgende logische bewerkingen: niet, en, of, eq (voor gelijk) en ne (voor niet gelijk). Er worden geen rekenkundige bewerkingen ondersteund. Hier volgt een geldig filtervoorbeeld: $filter=contains(namE, 'PATTERN') en de naam ne 'PATTERN-1'. Hier volgt geen geldig filtervoorbeeld: $filter=location eq 'westus'.

top

Het aantal resultaten dat per pagina moet worden geretourneerd voor de lijstbewerking. Geldig bereik voor topparameter is 1 tot 100. Als dit niet is opgegeven, is het standaardaantal te retourneren resultaten 20 items per pagina.

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

filter

De query die wordt gebruikt om de zoekresultaten te filteren met behulp van de OData-syntaxis. Filteren is alleen toegestaan voor de eigenschap 'name' en met een beperkt aantal OData-bewerkingen. Deze bewerkingen zijn: de functie 'contains' en de volgende logische bewerkingen: niet, en, of, eq (voor gelijk) en ne (voor niet gelijk). Er worden geen rekenkundige bewerkingen ondersteund. Hier volgt een geldig filtervoorbeeld: $filter=contains(namE, 'PATTERN') en de naam ne 'PATTERN-1'. Hier volgt geen geldig filtervoorbeeld: $filter=location eq 'westus'.

filter?: string

Waarde van eigenschap

string

top

Het aantal resultaten dat per pagina moet worden geretourneerd voor de lijstbewerking. Geldig bereik voor topparameter is 1 tot 100. Als dit niet is opgegeven, is het standaardaantal te retourneren resultaten 20 items per pagina.

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