@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
95 lines • 3.21 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Get subnetworks within GCE.
* See [the official documentation](https://cloud.google.com/vpc/docs/subnets)
* and [API](https://cloud.google.com/compute/docs/reference/rest/v1/subnetworks/list).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const my_subnetworks = gcp.compute.getSubnetworks({
* filter: "ipCidrRange eq 192.168.178.0/24",
* project: "my-project",
* region: "us-east1",
* });
* ```
*/
export declare function getSubnetworks(args?: GetSubnetworksArgs, opts?: pulumi.InvokeOptions): Promise<GetSubnetworksResult>;
/**
* A collection of arguments for invoking getSubnetworks.
*/
export interface GetSubnetworksArgs {
/**
* A string filter as defined in the [REST API](https://cloud.google.com/compute/docs/reference/rest/v1/subnetworks/list#query-parameters).
*/
filter?: string;
/**
* The ID of the project in which the resource belongs. If it
* is not provided, the provider project is used.
*/
project?: string;
/**
* The region this subnetwork has been created in. If
* unspecified, this defaults to the region configured in the provider.
*/
region?: string;
}
/**
* A collection of values returned by getSubnetworks.
*/
export interface GetSubnetworksResult {
readonly filter?: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly project?: string;
readonly region?: string;
/**
* A list of all retrieved GCE subnetworks. Structure is defined below.
*/
readonly subnetworks: outputs.compute.GetSubnetworksSubnetwork[];
}
/**
* Get subnetworks within GCE.
* See [the official documentation](https://cloud.google.com/vpc/docs/subnets)
* and [API](https://cloud.google.com/compute/docs/reference/rest/v1/subnetworks/list).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const my_subnetworks = gcp.compute.getSubnetworks({
* filter: "ipCidrRange eq 192.168.178.0/24",
* project: "my-project",
* region: "us-east1",
* });
* ```
*/
export declare function getSubnetworksOutput(args?: GetSubnetworksOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetSubnetworksResult>;
/**
* A collection of arguments for invoking getSubnetworks.
*/
export interface GetSubnetworksOutputArgs {
/**
* A string filter as defined in the [REST API](https://cloud.google.com/compute/docs/reference/rest/v1/subnetworks/list#query-parameters).
*/
filter?: pulumi.Input<string | undefined>;
/**
* The ID of the project in which the resource belongs. If it
* is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
/**
* The region this subnetwork has been created in. If
* unspecified, this defaults to the region configured in the provider.
*/
region?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=getSubnetworks.d.ts.map