Partilhar via

ResourcesListOptionalParams interface

  • Referência
Pacote:
@azure/arm-resources

Parâmetros opcionais.

Extends
OperationOptions

Propriedades

expand

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

O filtro a aplicar na operação.

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

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


substringof(value, property) pode ser utilizado para filtrar subcadeias das seguintes propriedades atualmente suportadas: name e resourceGroup

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

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

Tenha em atenção que qualquer número truncado de resultados consultados através $top de também pode não ser compatível ao utilizar um filtro.


Os recursos podem ser filtrados por nomes e valores de etiquetas. Por exemplo, para filtrar um nome e valor de etiqueta, utilize $filter=tagName eq 'tag1' and tagValue eq 'Value1'. Tenha em atenção que, quando os recursos são filtrados pelo nome e valor da etiqueta, as etiquetas originais para cada recurso não serão devolvidas nos resultados. Qualquer lista de propriedades adicionais consultadas através $expand de também pode não ser compatível ao filtrar por nomes/valores de etiquetas.

Apenas para nomes de etiquetas, os recursos podem ser filtrados por prefixo com a seguinte sintaxe: $filter=startswith(tagName, 'depart'). Esta consulta devolverá todos os recursos com um nome de etiqueta com o prefixo da expressão depart (ou sejadepartment, departureDate, departureTime, etc.)


Tenha em atenção 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 resultados a devolver. Se for transmitido um valor nulo, devolve todos os recursos.

Propriedades Herdadas

abortSignal

O sinal que pode ser utilizado para abortar pedidos.
onResponse

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

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

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

Opções utilizadas quando o rastreio está ativado.

Detalhes de Propriedade

expand

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

expand?: string

Valor de Propriedade

string

filter

O filtro a aplicar na operação.

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

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


substringof(value, property) pode ser utilizado para filtrar subcadeias das seguintes propriedades atualmente suportadas: name e resourceGroup

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

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

Tenha em atenção que qualquer número truncado de resultados consultados através $top de também pode não ser compatível ao utilizar um filtro.


Os recursos podem ser filtrados por nomes e valores de etiquetas. Por exemplo, para filtrar um nome e valor de etiqueta, utilize $filter=tagName eq 'tag1' and tagValue eq 'Value1'. Tenha em atenção que, quando os recursos são filtrados pelo nome e valor da etiqueta, as etiquetas originais para cada recurso não serão devolvidas nos resultados. Qualquer lista de propriedades adicionais consultadas através $expand de também pode não ser compatível ao filtrar por nomes/valores de etiquetas.

Apenas para nomes de etiquetas, os recursos podem ser filtrados por prefixo com a seguinte sintaxe: $filter=startswith(tagName, 'depart'). Esta consulta devolverá todos os recursos com um nome de etiqueta com o prefixo da expressão depart (ou sejadepartment, departureDate, departureTime, etc.)


Tenha em atenção 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 de Propriedade

string

top

O número de resultados a devolver. Se for transmitido um valor nulo, devolve todos os recursos.

top?: number

Valor de Propriedade

number

Detalhes da Propriedade Herdada

abortSignal

O sinal que pode ser utilizado para abortar pedidos.

abortSignal?: AbortSignalLike

Valor de 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 pedida. Pode ser chamado várias vezes.

onResponse?: RawResponseCallback

Valor de Propriedade

RawResponseCallback

Herdado de coreClient.OperationOptions.onResponse

requestOptions

Opções utilizadas ao criar e enviar pedidos HTTP para esta operação.

requestOptions?: OperationRequestOptions

Valor de Propriedade

OperationRequestOptions

Herdado de coreClient.OperationOptions.requestOptions

serializerOptions

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

serializerOptions?: SerializerOptions

Valor de Propriedade

SerializerOptions

Herdado de coreClient.OperationOptions.serializerOptions

tracingOptions

Opções utilizadas quando o rastreio está ativado.

tracingOptions?: OperationTracingOptions

Valor de Propriedade

OperationTracingOptions

Herdado de coreClient.OperationOptions.tracingOptions