Google Cloud Classic v8.9.3 published on Monday, Nov 18, 2024 by Pulumi
gcp.cloudquota.getSQuotaInfo
Explore with Pulumi AI
Provides information about a particular quota for a given project, folder or organization.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const myQuotaInfo = gcp.cloudquota.getSQuotaInfo({
parent: "projects/my-project",
service: "compute.googleapis.com",
quotaId: "CPUS-per-project-region",
});
import pulumi
import pulumi_gcp as gcp
my_quota_info = gcp.cloudquota.get_s_quota_info(parent="projects/my-project",
service="compute.googleapis.com",
quota_id="CPUS-per-project-region")
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/cloudquota"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := cloudquota.GetSQuotaInfo(ctx, &cloudquota.GetSQuotaInfoArgs{
Parent: "projects/my-project",
Service: "compute.googleapis.com",
QuotaId: "CPUS-per-project-region",
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var myQuotaInfo = Gcp.CloudQuota.GetSQuotaInfo.Invoke(new()
{
Parent = "projects/my-project",
Service = "compute.googleapis.com",
QuotaId = "CPUS-per-project-region",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.cloudquota.CloudquotaFunctions;
import com.pulumi.gcp.cloudquota.inputs.GetSQuotaInfoArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var myQuotaInfo = CloudquotaFunctions.getSQuotaInfo(GetSQuotaInfoArgs.builder()
.parent("projects/my-project")
.service("compute.googleapis.com")
.quotaId("CPUS-per-project-region")
.build());
}
}
variables:
myQuotaInfo:
fn::invoke:
Function: gcp:cloudquota:getSQuotaInfo
Arguments:
parent: projects/my-project
service: compute.googleapis.com
quotaId: CPUS-per-project-region
Using getSQuotaInfo
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getSQuotaInfo(args: GetSQuotaInfoArgs, opts?: InvokeOptions): Promise<GetSQuotaInfoResult>
function getSQuotaInfoOutput(args: GetSQuotaInfoOutputArgs, opts?: InvokeOptions): Output<GetSQuotaInfoResult>
def get_s_quota_info(parent: Optional[str] = None,
quota_id: Optional[str] = None,
service: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetSQuotaInfoResult
def get_s_quota_info_output(parent: Optional[pulumi.Input[str]] = None,
quota_id: Optional[pulumi.Input[str]] = None,
service: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetSQuotaInfoResult]
func GetSQuotaInfo(ctx *Context, args *GetSQuotaInfoArgs, opts ...InvokeOption) (*GetSQuotaInfoResult, error)
func GetSQuotaInfoOutput(ctx *Context, args *GetSQuotaInfoOutputArgs, opts ...InvokeOption) GetSQuotaInfoResultOutput
> Note: This function is named GetSQuotaInfo
in the Go SDK.
public static class GetSQuotaInfo
{
public static Task<GetSQuotaInfoResult> InvokeAsync(GetSQuotaInfoArgs args, InvokeOptions? opts = null)
public static Output<GetSQuotaInfoResult> Invoke(GetSQuotaInfoInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetSQuotaInfoResult> getSQuotaInfo(GetSQuotaInfoArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: gcp:cloudquota/getSQuotaInfo:getSQuotaInfo
arguments:
# arguments dictionary
The following arguments are supported:
- Parent string
- The parent of the quota info. Allowed parents are "projects/[project-id / number]" or "folders/[folder-id / number]" or "organizations/[org-id / number].
- Quota
Id string - The id of the quota, which is unique within the service.
- Service string
- The name of the service in which the quota is defined.
- Parent string
- The parent of the quota info. Allowed parents are "projects/[project-id / number]" or "folders/[folder-id / number]" or "organizations/[org-id / number].
- Quota
Id string - The id of the quota, which is unique within the service.
- Service string
- The name of the service in which the quota is defined.
- parent String
- The parent of the quota info. Allowed parents are "projects/[project-id / number]" or "folders/[folder-id / number]" or "organizations/[org-id / number].
- quota
Id String - The id of the quota, which is unique within the service.
- service String
- The name of the service in which the quota is defined.
- parent string
- The parent of the quota info. Allowed parents are "projects/[project-id / number]" or "folders/[folder-id / number]" or "organizations/[org-id / number].
- quota
Id string - The id of the quota, which is unique within the service.
- service string
- The name of the service in which the quota is defined.
- parent String
- The parent of the quota info. Allowed parents are "projects/[project-id / number]" or "folders/[folder-id / number]" or "organizations/[org-id / number].
- quota
Id String - The id of the quota, which is unique within the service.
- service String
- The name of the service in which the quota is defined.
getSQuotaInfo Result
The following output properties are available:
- Container
Type string - (Output) The container type of the QuotaInfo.
- Dimensions List<string>
- The map of dimensions for this dimensions info. The key of a map entry is "region", "zone" or the name of a service specific dimension, and the value of a map entry is the value of the dimension. If a dimension does not appear in the map of dimensions, the dimensions info applies to all the dimension values except for those that have another DimenisonInfo instance configured for the specific value. Example: {"provider" : "Foo Inc"} where "provider" is a service specific dimension of a quota.
- Dimensions
Infos List<GetSQuota Info Dimensions Info> - (Output) The collection of dimensions info ordered by their dimensions from more specific ones to less specific ones.
- Id string
- The provider-assigned unique ID for this managed resource.
- Is
Concurrent bool - (Output) Whether the quota is a concurrent quota. Concurrent quotas are enforced on the total number of concurrent operations in flight at any given time.
- Is
Fixed bool - (Output) Whether the quota value is fixed or adjustable.
- Is
Precise bool - (Output) Whether this is a precise quota. A precise quota is tracked with absolute precision. In contrast, an imprecise quota is not tracked with precision.
- Metric string
- (Output) The metric of the quota. It specifies the resources consumption the quota is defined for, for example:
compute.googleapis.com/cpus
. - Metric
Display stringName - (Output) The display name of the quota metric.
- Metric
Unit string - (Output) The unit in which the metric value is reported, e.g.,
MByte
. - Name string
- (Output) Resource name of this QuotaInfo, for example:
projects/123/locations/global/services/compute.googleapis.com/quotaInfos/CpusPerProjectPerRegion
. - Parent string
- Quota
Display stringName - (Output) The display name of the quota.
- Quota
Id string - Quota
Increase List<GetEligibilities SQuota Info Quota Increase Eligibility> - (Output) Whether it is eligible to request a higher quota value for this quota.
- Refresh
Interval string - (Output) The reset time interval for the quota. Refresh interval applies to rate quota only. Example: "minute" for per minute, "day" for per day, or "10 seconds" for every 10 seconds.
- Service string
- Service
Request stringQuota Uri - (Output) URI to the page where users can request more quota for the cloud service, for example:
https://console.cloud.google.com/iam-admin/quotas
.
- Container
Type string - (Output) The container type of the QuotaInfo.
- Dimensions []string
- The map of dimensions for this dimensions info. The key of a map entry is "region", "zone" or the name of a service specific dimension, and the value of a map entry is the value of the dimension. If a dimension does not appear in the map of dimensions, the dimensions info applies to all the dimension values except for those that have another DimenisonInfo instance configured for the specific value. Example: {"provider" : "Foo Inc"} where "provider" is a service specific dimension of a quota.
- Dimensions
Infos []GetSQuota Info Dimensions Info - (Output) The collection of dimensions info ordered by their dimensions from more specific ones to less specific ones.
- Id string
- The provider-assigned unique ID for this managed resource.
- Is
Concurrent bool - (Output) Whether the quota is a concurrent quota. Concurrent quotas are enforced on the total number of concurrent operations in flight at any given time.
- Is
Fixed bool - (Output) Whether the quota value is fixed or adjustable.
- Is
Precise bool - (Output) Whether this is a precise quota. A precise quota is tracked with absolute precision. In contrast, an imprecise quota is not tracked with precision.
- Metric string
- (Output) The metric of the quota. It specifies the resources consumption the quota is defined for, for example:
compute.googleapis.com/cpus
. - Metric
Display stringName - (Output) The display name of the quota metric.
- Metric
Unit string - (Output) The unit in which the metric value is reported, e.g.,
MByte
. - Name string
- (Output) Resource name of this QuotaInfo, for example:
projects/123/locations/global/services/compute.googleapis.com/quotaInfos/CpusPerProjectPerRegion
. - Parent string
- Quota
Display stringName - (Output) The display name of the quota.
- Quota
Id string - Quota
Increase []GetEligibilities SQuota Info Quota Increase Eligibility - (Output) Whether it is eligible to request a higher quota value for this quota.
- Refresh
Interval string - (Output) The reset time interval for the quota. Refresh interval applies to rate quota only. Example: "minute" for per minute, "day" for per day, or "10 seconds" for every 10 seconds.
- Service string
- Service
Request stringQuota Uri - (Output) URI to the page where users can request more quota for the cloud service, for example:
https://console.cloud.google.com/iam-admin/quotas
.
- container
Type String - (Output) The container type of the QuotaInfo.
- dimensions List<String>
- The map of dimensions for this dimensions info. The key of a map entry is "region", "zone" or the name of a service specific dimension, and the value of a map entry is the value of the dimension. If a dimension does not appear in the map of dimensions, the dimensions info applies to all the dimension values except for those that have another DimenisonInfo instance configured for the specific value. Example: {"provider" : "Foo Inc"} where "provider" is a service specific dimension of a quota.
- dimensions
Infos List<GetSQuota Info Dimensions Info> - (Output) The collection of dimensions info ordered by their dimensions from more specific ones to less specific ones.
- id String
- The provider-assigned unique ID for this managed resource.
- is
Concurrent Boolean - (Output) Whether the quota is a concurrent quota. Concurrent quotas are enforced on the total number of concurrent operations in flight at any given time.
- is
Fixed Boolean - (Output) Whether the quota value is fixed or adjustable.
- is
Precise Boolean - (Output) Whether this is a precise quota. A precise quota is tracked with absolute precision. In contrast, an imprecise quota is not tracked with precision.
- metric String
- (Output) The metric of the quota. It specifies the resources consumption the quota is defined for, for example:
compute.googleapis.com/cpus
. - metric
Display StringName - (Output) The display name of the quota metric.
- metric
Unit String - (Output) The unit in which the metric value is reported, e.g.,
MByte
. - name String
- (Output) Resource name of this QuotaInfo, for example:
projects/123/locations/global/services/compute.googleapis.com/quotaInfos/CpusPerProjectPerRegion
. - parent String
- quota
Display StringName - (Output) The display name of the quota.
- quota
Id String - quota
Increase List<GetEligibilities SQuota Info Quota Increase Eligibility> - (Output) Whether it is eligible to request a higher quota value for this quota.
- refresh
Interval String - (Output) The reset time interval for the quota. Refresh interval applies to rate quota only. Example: "minute" for per minute, "day" for per day, or "10 seconds" for every 10 seconds.
- service String
- service
Request StringQuota Uri - (Output) URI to the page where users can request more quota for the cloud service, for example:
https://console.cloud.google.com/iam-admin/quotas
.
- container
Type string - (Output) The container type of the QuotaInfo.
- dimensions string[]
- The map of dimensions for this dimensions info. The key of a map entry is "region", "zone" or the name of a service specific dimension, and the value of a map entry is the value of the dimension. If a dimension does not appear in the map of dimensions, the dimensions info applies to all the dimension values except for those that have another DimenisonInfo instance configured for the specific value. Example: {"provider" : "Foo Inc"} where "provider" is a service specific dimension of a quota.
- dimensions
Infos GetSQuota Info Dimensions Info[] - (Output) The collection of dimensions info ordered by their dimensions from more specific ones to less specific ones.
- id string
- The provider-assigned unique ID for this managed resource.
- is
Concurrent boolean - (Output) Whether the quota is a concurrent quota. Concurrent quotas are enforced on the total number of concurrent operations in flight at any given time.
- is
Fixed boolean - (Output) Whether the quota value is fixed or adjustable.
- is
Precise boolean - (Output) Whether this is a precise quota. A precise quota is tracked with absolute precision. In contrast, an imprecise quota is not tracked with precision.
- metric string
- (Output) The metric of the quota. It specifies the resources consumption the quota is defined for, for example:
compute.googleapis.com/cpus
. - metric
Display stringName - (Output) The display name of the quota metric.
- metric
Unit string - (Output) The unit in which the metric value is reported, e.g.,
MByte
. - name string
- (Output) Resource name of this QuotaInfo, for example:
projects/123/locations/global/services/compute.googleapis.com/quotaInfos/CpusPerProjectPerRegion
. - parent string
- quota
Display stringName - (Output) The display name of the quota.
- quota
Id string - quota
Increase GetEligibilities SQuota Info Quota Increase Eligibility[] - (Output) Whether it is eligible to request a higher quota value for this quota.
- refresh
Interval string - (Output) The reset time interval for the quota. Refresh interval applies to rate quota only. Example: "minute" for per minute, "day" for per day, or "10 seconds" for every 10 seconds.
- service string
- service
Request stringQuota Uri - (Output) URI to the page where users can request more quota for the cloud service, for example:
https://console.cloud.google.com/iam-admin/quotas
.
- container_
type str - (Output) The container type of the QuotaInfo.
- dimensions Sequence[str]
- The map of dimensions for this dimensions info. The key of a map entry is "region", "zone" or the name of a service specific dimension, and the value of a map entry is the value of the dimension. If a dimension does not appear in the map of dimensions, the dimensions info applies to all the dimension values except for those that have another DimenisonInfo instance configured for the specific value. Example: {"provider" : "Foo Inc"} where "provider" is a service specific dimension of a quota.
- dimensions_
infos Sequence[GetSQuota Info Dimensions Info] - (Output) The collection of dimensions info ordered by their dimensions from more specific ones to less specific ones.
- id str
- The provider-assigned unique ID for this managed resource.
- is_
concurrent bool - (Output) Whether the quota is a concurrent quota. Concurrent quotas are enforced on the total number of concurrent operations in flight at any given time.
- is_
fixed bool - (Output) Whether the quota value is fixed or adjustable.
- is_
precise bool - (Output) Whether this is a precise quota. A precise quota is tracked with absolute precision. In contrast, an imprecise quota is not tracked with precision.
- metric str
- (Output) The metric of the quota. It specifies the resources consumption the quota is defined for, for example:
compute.googleapis.com/cpus
. - metric_
display_ strname - (Output) The display name of the quota metric.
- metric_
unit str - (Output) The unit in which the metric value is reported, e.g.,
MByte
. - name str
- (Output) Resource name of this QuotaInfo, for example:
projects/123/locations/global/services/compute.googleapis.com/quotaInfos/CpusPerProjectPerRegion
. - parent str
- quota_
display_ strname - (Output) The display name of the quota.
- quota_
id str - quota_
increase_ Sequence[Geteligibilities SQuota Info Quota Increase Eligibility] - (Output) Whether it is eligible to request a higher quota value for this quota.
- refresh_
interval str - (Output) The reset time interval for the quota. Refresh interval applies to rate quota only. Example: "minute" for per minute, "day" for per day, or "10 seconds" for every 10 seconds.
- service str
- service_
request_ strquota_ uri - (Output) URI to the page where users can request more quota for the cloud service, for example:
https://console.cloud.google.com/iam-admin/quotas
.
- container
Type String - (Output) The container type of the QuotaInfo.
- dimensions List<String>
- The map of dimensions for this dimensions info. The key of a map entry is "region", "zone" or the name of a service specific dimension, and the value of a map entry is the value of the dimension. If a dimension does not appear in the map of dimensions, the dimensions info applies to all the dimension values except for those that have another DimenisonInfo instance configured for the specific value. Example: {"provider" : "Foo Inc"} where "provider" is a service specific dimension of a quota.
- dimensions
Infos List<Property Map> - (Output) The collection of dimensions info ordered by their dimensions from more specific ones to less specific ones.
- id String
- The provider-assigned unique ID for this managed resource.
- is
Concurrent Boolean - (Output) Whether the quota is a concurrent quota. Concurrent quotas are enforced on the total number of concurrent operations in flight at any given time.
- is
Fixed Boolean - (Output) Whether the quota value is fixed or adjustable.
- is
Precise Boolean - (Output) Whether this is a precise quota. A precise quota is tracked with absolute precision. In contrast, an imprecise quota is not tracked with precision.
- metric String
- (Output) The metric of the quota. It specifies the resources consumption the quota is defined for, for example:
compute.googleapis.com/cpus
. - metric
Display StringName - (Output) The display name of the quota metric.
- metric
Unit String - (Output) The unit in which the metric value is reported, e.g.,
MByte
. - name String
- (Output) Resource name of this QuotaInfo, for example:
projects/123/locations/global/services/compute.googleapis.com/quotaInfos/CpusPerProjectPerRegion
. - parent String
- quota
Display StringName - (Output) The display name of the quota.
- quota
Id String - quota
Increase List<Property Map>Eligibilities - (Output) Whether it is eligible to request a higher quota value for this quota.
- refresh
Interval String - (Output) The reset time interval for the quota. Refresh interval applies to rate quota only. Example: "minute" for per minute, "day" for per day, or "10 seconds" for every 10 seconds.
- service String
- service
Request StringQuota Uri - (Output) URI to the page where users can request more quota for the cloud service, for example:
https://console.cloud.google.com/iam-admin/quotas
.
Supporting Types
GetSQuotaInfoDimensionsInfo
- Applicable
Locations List<string> - The applicable regions or zones of this dimensions info. The field will be set to
['global']
for quotas that are not per region or per zone. Otherwise, it will be set to the list of locations this dimension info is applicable to. - Details
List<Get
SQuota Info Dimensions Info Detail> - The quota details for a map of dimensions.
- Dimensions Dictionary<string, string>
- The map of dimensions for this dimensions info. The key of a map entry is "region", "zone" or the name of a service specific dimension, and the value of a map entry is the value of the dimension. If a dimension does not appear in the map of dimensions, the dimensions info applies to all the dimension values except for those that have another DimenisonInfo instance configured for the specific value. Example: {"provider" : "Foo Inc"} where "provider" is a service specific dimension of a quota.
- Applicable
Locations []string - The applicable regions or zones of this dimensions info. The field will be set to
['global']
for quotas that are not per region or per zone. Otherwise, it will be set to the list of locations this dimension info is applicable to. - Details
[]Get
SQuota Info Dimensions Info Detail - The quota details for a map of dimensions.
- Dimensions map[string]string
- The map of dimensions for this dimensions info. The key of a map entry is "region", "zone" or the name of a service specific dimension, and the value of a map entry is the value of the dimension. If a dimension does not appear in the map of dimensions, the dimensions info applies to all the dimension values except for those that have another DimenisonInfo instance configured for the specific value. Example: {"provider" : "Foo Inc"} where "provider" is a service specific dimension of a quota.
- applicable
Locations List<String> - The applicable regions or zones of this dimensions info. The field will be set to
['global']
for quotas that are not per region or per zone. Otherwise, it will be set to the list of locations this dimension info is applicable to. - details
List<Get
SQuota Info Dimensions Info Detail> - The quota details for a map of dimensions.
- dimensions Map<String,String>
- The map of dimensions for this dimensions info. The key of a map entry is "region", "zone" or the name of a service specific dimension, and the value of a map entry is the value of the dimension. If a dimension does not appear in the map of dimensions, the dimensions info applies to all the dimension values except for those that have another DimenisonInfo instance configured for the specific value. Example: {"provider" : "Foo Inc"} where "provider" is a service specific dimension of a quota.
- applicable
Locations string[] - The applicable regions or zones of this dimensions info. The field will be set to
['global']
for quotas that are not per region or per zone. Otherwise, it will be set to the list of locations this dimension info is applicable to. - details
Get
SQuota Info Dimensions Info Detail[] - The quota details for a map of dimensions.
- dimensions {[key: string]: string}
- The map of dimensions for this dimensions info. The key of a map entry is "region", "zone" or the name of a service specific dimension, and the value of a map entry is the value of the dimension. If a dimension does not appear in the map of dimensions, the dimensions info applies to all the dimension values except for those that have another DimenisonInfo instance configured for the specific value. Example: {"provider" : "Foo Inc"} where "provider" is a service specific dimension of a quota.
- applicable_
locations Sequence[str] - The applicable regions or zones of this dimensions info. The field will be set to
['global']
for quotas that are not per region or per zone. Otherwise, it will be set to the list of locations this dimension info is applicable to. - details
Sequence[Get
SQuota Info Dimensions Info Detail] - The quota details for a map of dimensions.
- dimensions Mapping[str, str]
- The map of dimensions for this dimensions info. The key of a map entry is "region", "zone" or the name of a service specific dimension, and the value of a map entry is the value of the dimension. If a dimension does not appear in the map of dimensions, the dimensions info applies to all the dimension values except for those that have another DimenisonInfo instance configured for the specific value. Example: {"provider" : "Foo Inc"} where "provider" is a service specific dimension of a quota.
- applicable
Locations List<String> - The applicable regions or zones of this dimensions info. The field will be set to
['global']
for quotas that are not per region or per zone. Otherwise, it will be set to the list of locations this dimension info is applicable to. - details List<Property Map>
- The quota details for a map of dimensions.
- dimensions Map<String>
- The map of dimensions for this dimensions info. The key of a map entry is "region", "zone" or the name of a service specific dimension, and the value of a map entry is the value of the dimension. If a dimension does not appear in the map of dimensions, the dimensions info applies to all the dimension values except for those that have another DimenisonInfo instance configured for the specific value. Example: {"provider" : "Foo Inc"} where "provider" is a service specific dimension of a quota.
GetSQuotaInfoDimensionsInfoDetail
- Value string
- The value currently in effect and being enforced.
- Value string
- The value currently in effect and being enforced.
- value String
- The value currently in effect and being enforced.
- value string
- The value currently in effect and being enforced.
- value str
- The value currently in effect and being enforced.
- value String
- The value currently in effect and being enforced.
GetSQuotaInfoQuotaIncreaseEligibility
- Ineligibility
Reason string - The enumeration of reasons when it is ineligible to request increase adjustment.
- Is
Eligible bool - Whether a higher quota value can be requested for the quota.
- Ineligibility
Reason string - The enumeration of reasons when it is ineligible to request increase adjustment.
- Is
Eligible bool - Whether a higher quota value can be requested for the quota.
- ineligibility
Reason String - The enumeration of reasons when it is ineligible to request increase adjustment.
- is
Eligible Boolean - Whether a higher quota value can be requested for the quota.
- ineligibility
Reason string - The enumeration of reasons when it is ineligible to request increase adjustment.
- is
Eligible boolean - Whether a higher quota value can be requested for the quota.
- ineligibility_
reason str - The enumeration of reasons when it is ineligible to request increase adjustment.
- is_
eligible bool - Whether a higher quota value can be requested for the quota.
- ineligibility
Reason String - The enumeration of reasons when it is ineligible to request increase adjustment.
- is
Eligible Boolean - Whether a higher quota value can be requested for the quota.
Package Details
- Repository
- Google Cloud (GCP) Classic pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
google-beta
Terraform Provider.