Type Alias ListPrivateNetworksRequest

ListPrivateNetworksRequest: {
    dhcpEnabled?: boolean;
    name?: string;
    orderBy?: VPC.v2.ListPrivateNetworksRequestOrderBy;
    organizationId?: string;
    page?: number;
    pageSize?: number;
    privateNetworkIds?: string[];
    projectId?: string;
    region?: Region;
    tags?: string[];
    vpcId?: string;
}

Type declaration

  • OptionaldhcpEnabled?: boolean

    DHCP status to filter for. When true, only Private Networks with managed DHCP enabled will be returned.

  • Optionalname?: string

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

  • OptionalorderBy?: VPC.v2.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.

  • Optionalregion?: Region

    Region to target. If none is passed will use default region from the config.

  • Optionaltags?: string[]

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

  • OptionalvpcId?: string

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

Settings