Interface ListGroupsOptions
interface ListGroupsOptions {
name?: string;
networkId?: string;
ids?: Iterable<string, any, any>;
page?: number;
pageSize?: number;
timeout?: number;
}
name?: string;
networkId?: string;
ids?: Iterable<string, any, any>;
page?: number;
pageSize?: number;
timeout?: number;
}
Hierarchy (View Summary)
- TimeoutOptions
- ListGroupsOptions
Properties
Optionalname
name?: string
Keeps groups with this name, matched case-insensitively.
OptionalnetworkId
networkId?: string
Keeps groups assigned to this network.
Optionalids
ids?: Iterable<string, any, any>
Keeps only these groups. The service bounds how many one call may name. An empty collection filters nothing, since on the wire it reads as not given.
Optionalpage
page?: number
The page to return, counting from 1. Omitted, the first.
OptionalpageSize
pageSize?: number
How many groups a page holds. Omitted, the service's default.
Optionaltimeout
timeout?: number
Seconds to wait for this call. Defaults to the client's own timeout.
What NetworkOperations.listGroups narrows the listing by.