Struct azure_mgmt_resources::package_resources_2021_04::resources::list::RequestBuilder

pub struct RequestBuilder { /* private fields */ }

RequestBuilder provides a mechanism for setting optional parameters on a request.

Each RequestBuilder parameter method call returns Self, so setting of multiple parameters can be chained.

The building of a request is typically finalized by invoking .await on RequestBuilder. This implicitly invokes the IntoFuture::into_future() method, which converts RequestBuilder into a future that executes the request operation and returns a Result with the parsed response.

If you need lower-level access to the raw response details (e.g. to inspect response headers or raw body data) then you can finalize the request using the [RequestBuilder::send()] method which returns a future that resolves to a lower-level Response value.

Implementations

impl RequestBuilder

pub fn filter(self, filter: impl Into<String>) -> Self

The filter to apply on the operation.

Filter comparison operators include eq (equals) and ne (not equals) and may be used with the following properties: location, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/version, and plan/promotionCode.

For example, to filter by a resource type, use $filter=resourceType eq 'Microsoft.Network/virtualNetworks'


substringof(value, property) can be used to filter for substrings of the following currently-supported properties: name and resourceGroup

For example, to get all resources with ‘demo’ anywhere in the resource name, use $filter=substringof('demo', name)

Multiple substring operations can also be combined using and/or operators.

Note that any truncated number of results queried via $top may also not be compatible when using a filter.


Resources can be filtered by tag names and values. For example, to filter for a tag name and value, use $filter=tagName eq 'tag1' and tagValue eq 'Value1'. Note that when resources are filtered by tag name and value, the original tags for each resource will not be returned in the results. Any list of additional properties queried via $expand may also not be compatible when filtering by tag names/values.

For tag names only, resources can be filtered by prefix using the following syntax: $filter=startswith(tagName, 'depart'). This query will return all resources with a tag name prefixed by the phrase depart (i.e.department, departureDate, departureTime, etc.)


Note that some properties can be combined when filtering resources, which include the following: substringof() and/or resourceType, plan and plan/publisher and plan/name, and identity and identity/principalId.

pub fn expand(self, expand: impl Into<String>) -> Self

Comma-separated list of additional properties to be included in the response. Valid values include createdTime, changedTime and provisioningState. For example, $expand=createdTime,changedTime.

pub fn top(self, top: i32) -> Self

The number of recommendations per page if a paged version of this API is being used.

pub fn into_stream(self) -> Pageable<ResourceListResult, Error>

Trait Implementations

impl Clone for RequestBuilder

fn clone(&self) -> RequestBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.