Partager via

ResourcesListOptionalParams interface

  • Référence
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 sont createdTime, changedTime et provisioningState. Par exemple : $expand=createdTime,changedTime.
filter

Filtre à appliquer à l’opération.

Les opérateurs de comparaison de filtres incluent eq (est égal) et ne (différent) et peuvent être utilisés avec les propriétés suivantes : location, nameresourceType, identityplanresourceGroupidentity/principalId, 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) peut ê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 « demo » 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 de 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 de balise.

Pour les noms d’étiquette 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 (par exempledepartment, departureDate, departureTime, etc.)


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

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

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/désérialisation.
tracingOptions

Options utilisées lorsque le traçage 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 sont createdTime, changedTime et provisioningState. Par exemple : $expand=createdTime,changedTime.

expand?: string

Valeur de propriété

string

filter

Filtre à appliquer à l’opération.

Les opérateurs de comparaison de filtres incluent eq (est égal) et ne (différent) et peuvent être utilisés avec les propriétés suivantes : location, nameresourceType, identityplanresourceGroupidentity/principalId, 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) peut ê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 « demo » 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 de 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 de balise.

Pour les noms d’étiquette 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 (par exempledepartment, departureDate, departureTime, etc.)


Notez que certaines propriétés peuvent être combinées lors du filtrage des ressources, notamment les éléments suivants : 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 résultats à retourner. Si null est passé, 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 abandonner 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érialisation.

serializerOptions?: SerializerOptions

Valeur de propriété

SerializerOptions

Hérité de coreClient.OperationOptions.serializerOptions

tracingOptions

Options utilisées lorsque le traçage est activé.

tracingOptions?: OperationTracingOptions

Valeur de propriété

OperationTracingOptions

Hérité de coreClient.OperationOptions.tracingOptions