ResourcesListOptionalParams interface
Parâmetros opcionais.
- Extends
Propriedades
expand | Lista separada por vírgulas de propriedades adicionais a serem incluídas na resposta. Os valores válidos incluem |
filter | O filtro a ser aplicado na operação. |
top | O número de resultados a retornar. Se null for passado, retornará todos os recursos. |
Propriedades Herdadas
abort |
O sinal que pode ser usado para abortar solicitações. |
on |
Uma função a ser chamada cada vez que uma resposta é recebida do servidor durante a execução da operação solicitada. Pode ser chamado várias vezes. |
request |
Opções usadas ao criar e enviar solicitações HTTP para esta operação. |
serializer |
Opções para substituir o comportamento de serialização/desserialização. |
tracing |
Opções usadas quando o rastreamento está habilitado. |
Detalhes de 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 de Propriedade
string
filter
O filtro a ser aplicado na operação.
As propriedades que você pode usar para eq (igual) ou ne (não igual) 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 substring são: name e resourceGroup.
Por exemplo, para obter todos os recursos com 'demo' em qualquer lugar no nome, use: $filter=substringof('demo', name)
Você pode vincular mais de uma substringof juntando e/ou operadores.
Você pode filtrar por nomes e valores de tags. Por exemplo, para filtrar um nome e valor de tag, use $filter=tagName eq 'tag1' e tagValue eq 'Value1'. Quando você filtra por um nome e valor de tag, as tags 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 de Propriedade
string
top
O número de resultados a retornar. Se null for passado, retornará todos os recursos.
top?: number
Valor de Propriedade
number
Detalhes da Propriedade Herdada
abortSignal
O sinal que pode ser usado para abortar solicitações.
abortSignal?: AbortSignalLike
Valor de Propriedade
herdado de coreClient.OperationOptions.abortSignal
onResponse
Uma função a ser chamada cada vez que uma resposta é recebida do servidor durante a execução da operação solicitada. Pode ser chamado várias vezes.
onResponse?: RawResponseCallback
Valor de Propriedade
herdado de coreClient.OperationOptions.onResponse
requestOptions
Opções usadas ao criar e enviar solicitações HTTP para esta operação.
requestOptions?: OperationRequestOptions
Valor de Propriedade
herdado de coreClient.OperationOptions.requestOptions
serializerOptions
Opções para substituir o comportamento de serialização/desserialização.
serializerOptions?: SerializerOptions
Valor de Propriedade
herdado de coreClient.OperationOptions.serializerOptions
tracingOptions
Opções usadas quando o rastreamento está habilitado.
tracingOptions?: OperationTracingOptions
Valor de Propriedade
herdado de coreClient.OperationOptions.tracingOptions