Compartilhar via

ResourcesListOptionalParams interface

  • Referência
Pacote:
@azure/arm-resources-profile-2020-09-01-hybrid

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 createdTimee changedTimeprovisioningState. Por exemplo, $expand=createdTime,changedTime.
filter

O filtro a ser aplicado na operação.

As propriedades que você pode usar para eq (iguais) ou ne (não iguais) são: location, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/version e plan/promotionCode.

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

Você pode usar substringof(value, property) no filtro. As propriedades que você pode usar para subcadeia de caracteres são: name e resourceGroup.

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

Você pode vincular mais de uma subcadeia de caracteres adicionando operadores e/ou .

Você pode filtrar por nomes de marca e valores. Por exemplo, para filtrar um nome de marca e um valor, use $filter=tagName eq 'tag1' e tagValue eq 'Value1'. Quando você filtra por um nome de marca e um valor, as marcas de cada recurso não são retornadas nos resultados.

Você pode usar algumas propriedades juntas ao filtrar. As combinações que você pode usar são: substringof e/ou resourceType, plan e plan/publisher e plan/name, identity e identity/principalId.
top

O número de resultados a serem retornados. Se nulo for passado, retornará todos os recursos.

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 essa 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 createdTimee changedTimeprovisioningState. Por exemplo, $expand=createdTime,changedTime.

expand?: string

Valor da propriedade

string

filter

O filtro a ser aplicado na operação.

As propriedades que você pode usar para eq (iguais) ou ne (não iguais) são: location, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/version e plan/promotionCode.

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

Você pode usar substringof(value, property) no filtro. As propriedades que você pode usar para subcadeia de caracteres são: name e resourceGroup.

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

Você pode vincular mais de uma subcadeia de caracteres adicionando operadores e/ou .

Você pode filtrar por nomes de marca e valores. Por exemplo, para filtrar um nome de marca e um valor, use $filter=tagName eq 'tag1' e tagValue eq 'Value1'. Quando você filtra por um nome de marca e um valor, as marcas de cada recurso não são retornadas nos resultados.

Você pode usar algumas propriedades juntas ao filtrar. As combinações que você pode usar são: substringof e/ou resourceType, plan e plan/publisher e plan/name, identity e identity/principalId.

filter?: string

Valor da propriedade

string

top

O número de resultados a serem retornados. Se nulo for passado, retornará todos os recursos.

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 essa 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