ResourcesListOptionalParams interface

Paquet:

@azure/arm-resources

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 sur l’opération. Les opérateurs de comparaison de filtres incluent eq (égal à) et ne (non égal) et peuvent être utilisés avec les propriétés suivantes : location, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/versionet plan/promotionCode. Par exemple, pour filtrer par type de ressource, utilisez $filter=resourceType eq 'Microsoft.Network/virtualNetworks' substringof(value, property) pouvez être utilisé pour filtrer les sous-chaînes des propriétés actuellement prises en charge suivantes : name et resourceGroup Par exemple, pour obtenir toutes les ressources avec « démonstration » n’importe où dans le nom de la ressource, utilisez $filter=substringof('demo', name) Plusieurs opérations de sous-chaîne peuvent également être combinées à l’aide d’opérateurs and/or. Notez que tout nombre tronqué de résultats interrogés via $top peut également ne pas être compatible lors de l’utilisation d’un filtre. Les ressources peuvent être filtrées par noms et valeurs d’étiquette. Par exemple, pour filtrer un nom et une valeur de balise, utilisez $filter=tagName eq 'tag1' and tagValue eq 'Value1'. Notez que lorsque les ressources sont filtrées par nom et valeur de balise, les balises d’origine pour chaque ressource ne sont pas retournées dans les résultats. Toute liste de propriétés supplémentaires interrogées via $expand peut également ne pas être compatible lors du filtrage par noms/valeurs d’étiquettes. Pour les noms de balises uniquement, les ressources peuvent être filtrées par préfixe à l’aide de la syntaxe suivante : $filter=startswith(tagName, 'depart'). Cette requête retourne toutes les ressources avec un nom de balise préfixé par l’expression depart (c’est-à-diredepartment, departureDate, departureTime, etc.) Notez que certaines propriétés peuvent être combinées lors du filtrage des ressources, notamment les suivantes : substringof() and/or resourceType, plan and plan/publisher and plan/nameet identity and identity/principalId.
top	Nombre de recommandations par page si une version paginée de cette API est utilisée.

Propriétés héritées

abortSignal	Signal qui peut être utilisé pour abandonner 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/de dé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 sur l’opération.

Les opérateurs de comparaison de filtres incluent eq (égal à) et ne (non égal) et peuvent être utilisés avec les propriétés suivantes : location, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/versionet plan/promotionCode.

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


substringof(value, property) pouvez être utilisé pour filtrer les sous-chaînes des propriétés actuellement prises en charge suivantes : name et resourceGroup

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

Plusieurs opérations de sous-chaîne peuvent également être combinées à l’aide d’opérateurs and/or.

Notez que tout nombre tronqué de résultats interrogés via $top peut également ne pas être compatible lors de l’utilisation d’un filtre.


Les ressources peuvent être filtrées par noms et valeurs d’étiquette. Par exemple, pour filtrer un nom et une valeur de balise, utilisez $filter=tagName eq 'tag1' and tagValue eq 'Value1'. Notez que lorsque les ressources sont filtrées par nom et valeur de balise, les balises d’origine pour chaque ressource ne sont pas retournées dans les résultats. Toute liste de propriétés supplémentaires interrogées via $expand peut également ne pas être compatible lors du filtrage par noms/valeurs d’étiquettes.

Pour les noms de balises uniquement, les ressources peuvent être filtrées par préfixe à l’aide de la syntaxe suivante : $filter=startswith(tagName, 'depart'). Cette requête retourne toutes les ressources avec un nom de balise préfixé par l’expression depart (c’est-à-diredepartment, departureDate, departureTime, etc.)


Notez que certaines propriétés peuvent être combinées lors du filtrage des ressources, notamment les suivantes : substringof() and/or resourceType, plan and plan/publisher and plan/nameet identity and identity/principalId.

filter?: string

Valeur de propriété

string

top

Nombre de recommandations par page si une version paginée de cette API est utilisée.

top?: number

Valeur de propriété

number

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

abortSignal

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

abortSignal?: AbortSignalLike

Valeur de propriété

AbortSignalLike

héritée 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ée 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ée de coreClient.OperationOptions.requestOptions

serializerOptions

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

serializerOptions?: SerializerOptions

Valeur de propriété

SerializerOptions

héritée de coreClient.OperationOptions.serializerOptions

tracingOptions

Options utilisées lorsque le suivi est activé.

tracingOptions?: OperationTracingOptions

Valeur de propriété

OperationTracingOptions

héritée de coreClient.OperationOptions.tracingOptions