alicloud.apigateway.getGroups
This data source provides the api groups of the current Alibaba Cloud user.
Example Usage
using System.Collections.Generic;
using Pulumi;
using AliCloud = Pulumi.AliCloud;
return await Deployment.RunAsync(() =>
{
var dataApigatway = AliCloud.ApiGateway.GetGroups.Invoke(new()
{
OutputFile = "outgroups",
});
return new Dictionary<string, object?>
{
["firstGroupId"] = dataApigatway.Apply(getGroupsResult => getGroupsResult.Groups[0]?.Id),
};
});
package main
import (
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/apigateway"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
dataApigatway, err := apigateway.GetGroups(ctx, &apigateway.GetGroupsArgs{
OutputFile: pulumi.StringRef("outgroups"),
}, nil)
if err != nil {
return err
}
ctx.Export("firstGroupId", dataApigatway.Groups[0].Id)
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.apigateway.ApigatewayFunctions;
import com.pulumi.alicloud.apigateway.inputs.GetGroupsArgs;
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 dataApigatway = ApigatewayFunctions.getGroups(GetGroupsArgs.builder()
.outputFile("outgroups")
.build());
ctx.export("firstGroupId", dataApigatway.applyValue(getGroupsResult -> getGroupsResult.groups()[0].id()));
}
}
import pulumi
import pulumi_alicloud as alicloud
data_apigatway = alicloud.apigateway.get_groups(output_file="outgroups")
pulumi.export("firstGroupId", data_apigatway.groups[0].id)
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const dataApigatway = alicloud.apigateway.getGroups({
outputFile: "outgroups",
});
export const firstGroupId = dataApigatway.then(dataApigatway => dataApigatway.groups?.[0]?.id);
variables:
dataApigatway:
fn::invoke:
Function: alicloud:apigateway:getGroups
Arguments:
outputFile: outgroups
outputs:
firstGroupId: ${dataApigatway.groups[0].id}
Using getGroups
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 getGroups(args: GetGroupsArgs, opts?: InvokeOptions): Promise<GetGroupsResult>
function getGroupsOutput(args: GetGroupsOutputArgs, opts?: InvokeOptions): Output<GetGroupsResult>
def get_groups(ids: Optional[Sequence[str]] = None,
name_regex: Optional[str] = None,
output_file: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetGroupsResult
def get_groups_output(ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
name_regex: Optional[pulumi.Input[str]] = None,
output_file: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetGroupsResult]
func GetGroups(ctx *Context, args *GetGroupsArgs, opts ...InvokeOption) (*GetGroupsResult, error)
func GetGroupsOutput(ctx *Context, args *GetGroupsOutputArgs, opts ...InvokeOption) GetGroupsResultOutput
> Note: This function is named GetGroups
in the Go SDK.
public static class GetGroups
{
public static Task<GetGroupsResult> InvokeAsync(GetGroupsArgs args, InvokeOptions? opts = null)
public static Output<GetGroupsResult> Invoke(GetGroupsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetGroupsResult> getGroups(GetGroupsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: alicloud:apigateway/getGroups:getGroups
arguments:
# arguments dictionary
The following arguments are supported:
- Ids List<string>
A list of api group IDs.
- Name
Regex string A regex string to filter api gateway groups by name.
- Output
File string
- Ids []string
A list of api group IDs.
- Name
Regex string A regex string to filter api gateway groups by name.
- Output
File string
- ids List<String>
A list of api group IDs.
- name
Regex String A regex string to filter api gateway groups by name.
- output
File String
- ids string[]
A list of api group IDs.
- name
Regex string A regex string to filter api gateway groups by name.
- output
File string
- ids Sequence[str]
A list of api group IDs.
- name_
regex str A regex string to filter api gateway groups by name.
- output_
file str
- ids List<String>
A list of api group IDs.
- name
Regex String A regex string to filter api gateway groups by name.
- output
File String
getGroups Result
The following output properties are available:
- Groups
List<Pulumi.
Ali Cloud. Api Gateway. Outputs. Get Groups Group> A list of api groups. Each element contains the following attributes:
- Id string
The provider-assigned unique ID for this managed resource.
- Ids List<string>
A list of api group IDs.
- Names List<string>
A list of api group names.
- Name
Regex string - Output
File string
- Groups
[]Get
Groups Group A list of api groups. Each element contains the following attributes:
- Id string
The provider-assigned unique ID for this managed resource.
- Ids []string
A list of api group IDs.
- Names []string
A list of api group names.
- Name
Regex string - Output
File string
- groups
List<Get
Groups Group> A list of api groups. Each element contains the following attributes:
- id String
The provider-assigned unique ID for this managed resource.
- ids List<String>
A list of api group IDs.
- names List<String>
A list of api group names.
- name
Regex String - output
File String
- groups
Get
Groups Group[] A list of api groups. Each element contains the following attributes:
- id string
The provider-assigned unique ID for this managed resource.
- ids string[]
A list of api group IDs.
- names string[]
A list of api group names.
- name
Regex string - output
File string
- groups
Sequence[Get
Groups Group] A list of api groups. Each element contains the following attributes:
- id str
The provider-assigned unique ID for this managed resource.
- ids Sequence[str]
A list of api group IDs.
- names Sequence[str]
A list of api group names.
- name_
regex str - output_
file str
- groups List<Property Map>
A list of api groups. Each element contains the following attributes:
- id String
The provider-assigned unique ID for this managed resource.
- ids List<String>
A list of api group IDs.
- names List<String>
A list of api group names.
- name
Regex String - output
File String
Supporting Types
GetGroupsGroup
- Billing
Status string Billing status.
- NORMAL: The API group is normal.
- LOCKED: Locked due to outstanding payment.
- Created
Time string Creation time (Greenwich mean time).
- Description string
API group description.
- Id string
API group ID, which is generated by the system and globally unique.
- Illegal
Status string Locking in invalid state.
- NORMAL: The API group is normal.
- LOCKED: Locked due to illegality.
- Modified
Time string Last modification time (Greenwich mean time).
- Name string
API group name.
- Region
Id string The ID of the region where the API group is located.
- Sub
Domain string Second-level domain name automatically assigned to the API group.
- Traffic
Limit int Upper QPS limit of the API group; default value: 500, which can be increased by submitting an application.
- Billing
Status string Billing status.
- NORMAL: The API group is normal.
- LOCKED: Locked due to outstanding payment.
- Created
Time string Creation time (Greenwich mean time).
- Description string
API group description.
- Id string
API group ID, which is generated by the system and globally unique.
- Illegal
Status string Locking in invalid state.
- NORMAL: The API group is normal.
- LOCKED: Locked due to illegality.
- Modified
Time string Last modification time (Greenwich mean time).
- Name string
API group name.
- Region
Id string The ID of the region where the API group is located.
- Sub
Domain string Second-level domain name automatically assigned to the API group.
- Traffic
Limit int Upper QPS limit of the API group; default value: 500, which can be increased by submitting an application.
- billing
Status String Billing status.
- NORMAL: The API group is normal.
- LOCKED: Locked due to outstanding payment.
- created
Time String Creation time (Greenwich mean time).
- description String
API group description.
- id String
API group ID, which is generated by the system and globally unique.
- illegal
Status String Locking in invalid state.
- NORMAL: The API group is normal.
- LOCKED: Locked due to illegality.
- modified
Time String Last modification time (Greenwich mean time).
- name String
API group name.
- region
Id String The ID of the region where the API group is located.
- sub
Domain String Second-level domain name automatically assigned to the API group.
- traffic
Limit Integer Upper QPS limit of the API group; default value: 500, which can be increased by submitting an application.
- billing
Status string Billing status.
- NORMAL: The API group is normal.
- LOCKED: Locked due to outstanding payment.
- created
Time string Creation time (Greenwich mean time).
- description string
API group description.
- id string
API group ID, which is generated by the system and globally unique.
- illegal
Status string Locking in invalid state.
- NORMAL: The API group is normal.
- LOCKED: Locked due to illegality.
- modified
Time string Last modification time (Greenwich mean time).
- name string
API group name.
- region
Id string The ID of the region where the API group is located.
- sub
Domain string Second-level domain name automatically assigned to the API group.
- traffic
Limit number Upper QPS limit of the API group; default value: 500, which can be increased by submitting an application.
- billing_
status str Billing status.
- NORMAL: The API group is normal.
- LOCKED: Locked due to outstanding payment.
- created_
time str Creation time (Greenwich mean time).
- description str
API group description.
- id str
API group ID, which is generated by the system and globally unique.
- illegal_
status str Locking in invalid state.
- NORMAL: The API group is normal.
- LOCKED: Locked due to illegality.
- modified_
time str Last modification time (Greenwich mean time).
- name str
API group name.
- region_
id str The ID of the region where the API group is located.
- sub_
domain str Second-level domain name automatically assigned to the API group.
- traffic_
limit int Upper QPS limit of the API group; default value: 500, which can be increased by submitting an application.
- billing
Status String Billing status.
- NORMAL: The API group is normal.
- LOCKED: Locked due to outstanding payment.
- created
Time String Creation time (Greenwich mean time).
- description String
API group description.
- id String
API group ID, which is generated by the system and globally unique.
- illegal
Status String Locking in invalid state.
- NORMAL: The API group is normal.
- LOCKED: Locked due to illegality.
- modified
Time String Last modification time (Greenwich mean time).
- name String
API group name.
- region
Id String The ID of the region where the API group is located.
- sub
Domain String Second-level domain name automatically assigned to the API group.
- traffic
Limit Number Upper QPS limit of the API group; default value: 500, which can be increased by submitting an application.
Package Details
- Repository
- Alibaba Cloud pulumi/pulumi-alicloud
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
alicloud
Terraform Provider.