Compartilhar via

ResourcesListOptionalParams interface

Pacote:
@azure/arm-resources

Parâmetros opcionais.

Extends
OperationOptions

Propriedades

expand

Lista separada por vírgulas de propriedades adicionais a serem incluídas na resposta. Os valores válidos incluem createdTime, changedTime e provisioningState. Por exemplo, $expand=createdTime,changedTime.
filter

O filtro a ser aplicado na operação.

Os operadores de comparação de filtro incluem eq (iguais) e ne (não iguais) e podem ser usados com as seguintes propriedades: location, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/versione plan/promotionCode.

Por exemplo, para filtrar por um tipo de recurso, use $filter=resourceType eq 'Microsoft.Network/virtualNetworks'


substringof(value, property) pode ser usado para filtrar subcadeias de caracteres das seguintes propriedades com suporte no momento: name e resourceGroup

Por exemplo, para obter todos os recursos com 'demonstração' em qualquer lugar no nome do recurso, use $filter=substringof('demo', name)

Várias operações de subcadeia de caracteres também podem ser combinadas usando operadores and/or.

Observe que qualquer número truncado de resultados consultados por meio de $top também pode não ser compatível ao usar um filtro.


Os recursos podem ser filtrados por nomes e valores de marca. Por exemplo, para filtrar um nome e um valor de marca, use $filter=tagName eq 'tag1' and tagValue eq 'Value1'. Observe que quando os recursos são filtrados por nome e valor de marca, as marcas originais de cada recurso não serão retornadas nos resultados. Qualquer lista de propriedades adicionais consultadas por meio de $expand também pode não ser compatível ao filtrar por nomes/valores de marca.

Somente para nomes de marca, os recursos podem ser filtrados por prefixo usando a seguinte sintaxe: $filter=startswith(tagName, 'depart'). Essa consulta retornará todos os recursos com um nome de marca prefixado pela frase depart (ou seja,department, departureDate, departureTime, etc.)


Observe que algumas propriedades podem ser combinadas ao filtrar recursos, que incluem o seguinte: substringof() and/or resourceType, plan and plan/publisher and plan/namee identity and identity/principalId.
top

O número de recomendações por página se uma versão paginada dessa API estiver sendo usada.

Propriedades herdadas

abortSignal

O sinal que pode ser usado para anular solicitações.
onResponse

Uma função a ser chamada sempre que uma resposta é recebida do servidor durante a execução da operação solicitada. Pode ser chamado várias vezes.
requestOptions

Opções usadas ao criar e enviar solicitações HTTP para esta operação.
serializerOptions

Opções para substituir o comportamento de serialização/des serialização.
tracingOptions

Opções usadas quando o rastreamento está habilitado.

Detalhes da propriedade

expand

Lista separada por vírgulas de propriedades adicionais a serem incluídas na resposta. Os valores válidos incluem createdTime, changedTime e provisioningState. Por exemplo, $expand=createdTime,changedTime.

expand?: string

Valor da propriedade

string

filter

O filtro a ser aplicado na operação.

Os operadores de comparação de filtro incluem eq (iguais) e ne (não iguais) e podem ser usados com as seguintes propriedades: location, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/versione plan/promotionCode.

Por exemplo, para filtrar por um tipo de recurso, use $filter=resourceType eq 'Microsoft.Network/virtualNetworks'


substringof(value, property) pode ser usado para filtrar subcadeias de caracteres das seguintes propriedades com suporte no momento: name e resourceGroup

Por exemplo, para obter todos os recursos com 'demonstração' em qualquer lugar no nome do recurso, use $filter=substringof('demo', name)

Várias operações de subcadeia de caracteres também podem ser combinadas usando operadores and/or.

Observe que qualquer número truncado de resultados consultados por meio de $top também pode não ser compatível ao usar um filtro.


Os recursos podem ser filtrados por nomes e valores de marca. Por exemplo, para filtrar um nome e um valor de marca, use $filter=tagName eq 'tag1' and tagValue eq 'Value1'. Observe que quando os recursos são filtrados por nome e valor de marca, as marcas originais de cada recurso não serão retornadas nos resultados. Qualquer lista de propriedades adicionais consultadas por meio de $expand também pode não ser compatível ao filtrar por nomes/valores de marca.

Somente para nomes de marca, os recursos podem ser filtrados por prefixo usando a seguinte sintaxe: $filter=startswith(tagName, 'depart'). Essa consulta retornará todos os recursos com um nome de marca prefixado pela frase depart (ou seja,department, departureDate, departureTime, etc.)


Observe que algumas propriedades podem ser combinadas ao filtrar recursos, que incluem o seguinte: substringof() and/or resourceType, plan and plan/publisher and plan/namee identity and identity/principalId.

filter?: string

Valor da propriedade

string

top

O número de recomendações por página se uma versão paginada dessa API estiver sendo usada.

top?: number

Valor da propriedade

number

Detalhes das propriedades herdadas

abortSignal

O sinal que pode ser usado para anular solicitações.

abortSignal?: AbortSignalLike

Valor da propriedade

AbortSignalLike

herdado de coreClient.OperationOptions.abortSignal

onResponse

Uma função a ser chamada sempre que uma resposta é recebida do servidor durante a execução da operação solicitada. Pode ser chamado várias vezes.

onResponse?: RawResponseCallback

Valor da propriedade

RawResponseCallback

Herdado de coreClient.OperationOptions.onResponse

requestOptions

Opções usadas ao criar e enviar solicitações HTTP para esta operação.

requestOptions?: OperationRequestOptions

Valor da propriedade

OperationRequestOptions

herdado de coreClient.OperationOptions.requestOptions

serializerOptions

Opções para substituir o comportamento de serialização/des serialização.

serializerOptions?: SerializerOptions

Valor da propriedade

SerializerOptions

Herdado de coreClient.OperationOptions.serializerOptions

tracingOptions

Opções usadas quando o rastreamento está habilitado.

tracingOptions?: OperationTracingOptions

Valor da propriedade

OperationTracingOptions

Herdado de coreClient.OperationOptions.tracingOptions