Type Alias ListPrivateNetworksRequest

ListPrivateNetworksRequest: {
    includeRegional?: boolean;
    name?: string;
    orderBy?: VPC.v1.ListPrivateNetworksRequestOrderBy;
    organizationId?: string;
    page?: number;
    pageSize?: number;
    privateNetworkIds?: string[];
    projectId?: string;
    tags?: string[];
    zone?: Zone;
}

Type declaration

  • OptionalincludeRegional?: boolean

    Defines whether to include regional Private Networks in the response.

  • Optionalname?: string

    Name to filter for. Only Private Networks with names containing this string will be returned.

  • OptionalorderBy?: VPC.v1.ListPrivateNetworksRequestOrderBy

    Sort order of the returned Private Networks.

  • OptionalorganizationId?: string

    Organization ID to filter for. Only Private Networks belonging to this Organization will be returned.

  • Optionalpage?: number

    Page number to return, from the paginated results.

  • OptionalpageSize?: number

    Maximum number of Private Networks to return per page.

  • OptionalprivateNetworkIds?: string[]

    Private Network IDs to filter for. Only Private Networks with one of these IDs will be returned.

  • OptionalprojectId?: string

    Project ID to filter for. Only Private Networks belonging to this Project will be returned.

  • Optionaltags?: string[]

    Tags to filter for. Only Private Networks with one or more matching tags will be returned.

  • Optionalzone?: Zone

    Zone to target. If none is passed will use default zone from the config.

Settings