Partager via

ResourcesListOptionalParams interface

  • Référence
Paquet:
@azure/arm-resources-profile-2020-09-01-hybrid

Paramètres facultatifs.

Extends
OperationOptions

Propriétés

expand

Liste séparée par des virgules des propriétés supplémentaires à inclure dans la réponse. Les valeurs valides incluent createdTime, changedTime et provisioningState. Par exemple : $expand=createdTime,changedTime.
filter

Filtre à appliquer à l’opération.

Les propriétés que vous pouvez utiliser pour eq (égal) ou ne (non égal) sont les suivantes : location, resourceType, name, resourceGroup, identity, identity/principalId, plan/publisher, plan/product, plan/name, plan/version et plan/promotionCode.

Par exemple, pour filtrer par un type de ressource, utilisez : $filter=resourceType eq 'Microsoft.Network/virtualNetworks'

Vous pouvez utiliser substringof(value, property) dans le filtre. Les propriétés que vous pouvez utiliser pour la sous-chaîne sont : name et resourceGroup.

Par exemple, pour obtenir toutes les ressources avec « demo » n’importe où dans le nom, utilisez : $filter=substringof('demo', name)

Vous pouvez lier plusieurs sous-chaînes en ajoutant des opérateurs et/ou.

Vous pouvez filtrer par noms et valeurs de balise. Par exemple, pour filtrer un nom et une valeur de balise, utilisez $filter=tagName eq 'tag1' et tagValue eq 'Value1'. Lorsque vous filtrez par un nom et une valeur de balise, les balises de chaque ressource ne sont pas retournées dans les résultats.

Vous pouvez utiliser certaines propriétés ensemble lors du filtrage. Les combinaisons que vous pouvez utiliser sont les suivantes : sous-chaîneof et/ou resourceType, plan et plan/publisher et plan/name, identity et identity/principalId.
top

Nombre de résultats à retourner. Si la valeur null est transmise, retourne toutes les ressources.

Propriétés héritées

abortSignal

Signal qui peut être utilisé pour annuler les demandes.
onResponse

Fonction à appeler chaque fois qu’une réponse est reçue du serveur lors de l’exécution de l’opération demandée. Peut être appelé plusieurs fois.
requestOptions

Options utilisées lors de la création et de l’envoi de requêtes HTTP pour cette opération.
serializerOptions

Options permettant de remplacer le comportement de sérialisation/dés sérialisation.
tracingOptions

Options utilisées lorsque le suivi est activé.

Détails de la propriété

expand

Liste séparée par des virgules des propriétés supplémentaires à inclure dans la réponse. Les valeurs valides incluent createdTime, changedTime et provisioningState. Par exemple : $expand=createdTime,changedTime.

expand?: string

Valeur de propriété

string

filter

Filtre à appliquer à l’opération.

Les propriétés que vous pouvez utiliser pour eq (égal) ou ne (non égal) sont les suivantes : location, resourceType, name, resourceGroup, identity, identity/principalId, plan/publisher, plan/product, plan/name, plan/version et plan/promotionCode.

Par exemple, pour filtrer par un type de ressource, utilisez : $filter=resourceType eq 'Microsoft.Network/virtualNetworks'

Vous pouvez utiliser substringof(value, property) dans le filtre. Les propriétés que vous pouvez utiliser pour la sous-chaîne sont : name et resourceGroup.

Par exemple, pour obtenir toutes les ressources avec « demo » n’importe où dans le nom, utilisez : $filter=substringof('demo', name)

Vous pouvez lier plusieurs sous-chaînes en ajoutant des opérateurs et/ou.

Vous pouvez filtrer par noms et valeurs de balise. Par exemple, pour filtrer un nom et une valeur de balise, utilisez $filter=tagName eq 'tag1' et tagValue eq 'Value1'. Lorsque vous filtrez par un nom et une valeur de balise, les balises de chaque ressource ne sont pas retournées dans les résultats.

Vous pouvez utiliser certaines propriétés ensemble lors du filtrage. Les combinaisons que vous pouvez utiliser sont les suivantes : sous-chaîneof et/ou resourceType, plan et plan/publisher et plan/name, identity et identity/principalId.

filter?: string

Valeur de propriété

string

top

Nombre de résultats à retourner. Si la valeur null est transmise, retourne toutes les ressources.

top?: number

Valeur de propriété

number

Détails de la propriété héritée

abortSignal

Signal qui peut être utilisé pour annuler les demandes.

abortSignal?: AbortSignalLike

Valeur de propriété

AbortSignalLike

Hérité de coreClient.OperationOptions.abortSignal

onResponse

Fonction à appeler chaque fois qu’une réponse est reçue du serveur lors de l’exécution de l’opération demandée. Peut être appelé plusieurs fois.

onResponse?: RawResponseCallback

Valeur de propriété

RawResponseCallback

Hérité de coreClient.OperationOptions.onResponse

requestOptions

Options utilisées lors de la création et de l’envoi de requêtes HTTP pour cette opération.

requestOptions?: OperationRequestOptions

Valeur de propriété

OperationRequestOptions

Hérité de coreClient.OperationOptions.requestOptions

serializerOptions

Options permettant de remplacer le comportement de sérialisation/dés sérialisation.

serializerOptions?: SerializerOptions

Valeur de propriété

SerializerOptions

Hérité de coreClient.OperationOptions.serializerOptions

tracingOptions

Options utilisées lorsque le suivi est activé.

tracingOptions?: OperationTracingOptions

Valeur de propriété

OperationTracingOptions

Hérité de coreClient.OperationOptions.tracingOptions