Google Cloud Native v0.28.0, Feb 2 23

google-native.apigee/v1.getEnvironment

Gets environment details.

Using getEnvironment

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 getEnvironment(args: GetEnvironmentArgs, opts?: InvokeOptions): Promise<GetEnvironmentResult>
function getEnvironmentOutput(args: GetEnvironmentOutputArgs, opts?: InvokeOptions): Output<GetEnvironmentResult>

def get_environment(environment_id: Optional[str] = None,
                    organization_id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetEnvironmentResult
def get_environment_output(environment_id: Optional[pulumi.Input[str]] = None,
                    organization_id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetEnvironmentResult]

func LookupEnvironment(ctx *Context, args *LookupEnvironmentArgs, opts ...InvokeOption) (*LookupEnvironmentResult, error)
func LookupEnvironmentOutput(ctx *Context, args *LookupEnvironmentOutputArgs, opts ...InvokeOption) LookupEnvironmentResultOutput

> Note: This function is named LookupEnvironment in the Go SDK.

public static class GetEnvironment 
{
    public static Task<GetEnvironmentResult> InvokeAsync(GetEnvironmentArgs args, InvokeOptions? opts = null)
    public static Output<GetEnvironmentResult> Invoke(GetEnvironmentInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetEnvironmentResult> getEnvironment(GetEnvironmentArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: google-native:apigee/v1:getEnvironment
  arguments:
    # arguments dictionary

The following arguments are supported:

EnvironmentId string
OrganizationId string

EnvironmentId string
OrganizationId string

environmentId String
organizationId String

environmentId string
organizationId string

environment_id str
organization_id str

environmentId String
organizationId String

getEnvironment Result

The following output properties are available:

ApiProxyType string: Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed.
CreatedAt string: Creation time of this environment as milliseconds since epoch.
DeploymentType string: Optional. Deployment type supported by the environment. The deployment type can be set when creating the environment and cannot be changed. When you enable archive deployment, you will be prevented from performing a subset of actions within the environment, including: * Managing the deployment of API proxy or shared flow revisions * Creating, updating, or deleting resource files * Creating, updating, or deleting target servers
Description string: Optional. Description of the environment.
DisplayName string: Optional. Display name for this environment.
ForwardProxyUri string: Optional. Url of the forward proxy to be applied to the runtime instances in this environment. Must be in the format of {scheme}://{hostname}:{port}. Note that scheme must be one of "http" or "https", and port must be supplied.
LastModifiedAt string: Last modification time of this environment as milliseconds since epoch.
Name string: Name of the environment. Values must match the regular expression ^[.\\p{Alnum}-_]{1,255}$
NodeConfig Pulumi.GoogleNative.Apigee.V1.Outputs.GoogleCloudApigeeV1NodeConfigResponse: Optional. NodeConfig of the environment.
Properties Pulumi.GoogleNative.Apigee.V1.Outputs.GoogleCloudApigeeV1PropertiesResponse: Optional. Key-value pairs that may be used for customizing the environment.
State string: State of the environment. Values other than ACTIVE means the resource is not ready to use.

ApiProxyType string: Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed.
CreatedAt string: Creation time of this environment as milliseconds since epoch.
DeploymentType string: Optional. Deployment type supported by the environment. The deployment type can be set when creating the environment and cannot be changed. When you enable archive deployment, you will be prevented from performing a subset of actions within the environment, including: * Managing the deployment of API proxy or shared flow revisions * Creating, updating, or deleting resource files * Creating, updating, or deleting target servers
Description string: Optional. Description of the environment.
DisplayName string: Optional. Display name for this environment.
ForwardProxyUri string: Optional. Url of the forward proxy to be applied to the runtime instances in this environment. Must be in the format of {scheme}://{hostname}:{port}. Note that scheme must be one of "http" or "https", and port must be supplied.
LastModifiedAt string: Last modification time of this environment as milliseconds since epoch.
Name string: Name of the environment. Values must match the regular expression ^[.\\p{Alnum}-_]{1,255}$
NodeConfig GoogleCloudApigeeV1NodeConfigResponse: Optional. NodeConfig of the environment.
Properties GoogleCloudApigeeV1PropertiesResponse: Optional. Key-value pairs that may be used for customizing the environment.
State string: State of the environment. Values other than ACTIVE means the resource is not ready to use.

apiProxyType String: Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed.
createdAt String: Creation time of this environment as milliseconds since epoch.
deploymentType String: Optional. Deployment type supported by the environment. The deployment type can be set when creating the environment and cannot be changed. When you enable archive deployment, you will be prevented from performing a subset of actions within the environment, including: * Managing the deployment of API proxy or shared flow revisions * Creating, updating, or deleting resource files * Creating, updating, or deleting target servers
description String: Optional. Description of the environment.
displayName String: Optional. Display name for this environment.
forwardProxyUri String: Optional. Url of the forward proxy to be applied to the runtime instances in this environment. Must be in the format of {scheme}://{hostname}:{port}. Note that scheme must be one of "http" or "https", and port must be supplied.
lastModifiedAt String: Last modification time of this environment as milliseconds since epoch.
name String: Name of the environment. Values must match the regular expression ^[.\\p{Alnum}-_]{1,255}$
nodeConfig GoogleCloudApigeeV1NodeConfigResponse: Optional. NodeConfig of the environment.
properties GoogleCloudApigeeV1PropertiesResponse: Optional. Key-value pairs that may be used for customizing the environment.
state String: State of the environment. Values other than ACTIVE means the resource is not ready to use.

apiProxyType string: Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed.
createdAt string: Creation time of this environment as milliseconds since epoch.
deploymentType string: Optional. Deployment type supported by the environment. The deployment type can be set when creating the environment and cannot be changed. When you enable archive deployment, you will be prevented from performing a subset of actions within the environment, including: * Managing the deployment of API proxy or shared flow revisions * Creating, updating, or deleting resource files * Creating, updating, or deleting target servers
description string: Optional. Description of the environment.
displayName string: Optional. Display name for this environment.
forwardProxyUri string: Optional. Url of the forward proxy to be applied to the runtime instances in this environment. Must be in the format of {scheme}://{hostname}:{port}. Note that scheme must be one of "http" or "https", and port must be supplied.
lastModifiedAt string: Last modification time of this environment as milliseconds since epoch.
name string: Name of the environment. Values must match the regular expression ^[.\\p{Alnum}-_]{1,255}$
nodeConfig GoogleCloudApigeeV1NodeConfigResponse: Optional. NodeConfig of the environment.
properties GoogleCloudApigeeV1PropertiesResponse: Optional. Key-value pairs that may be used for customizing the environment.
state string: State of the environment. Values other than ACTIVE means the resource is not ready to use.

api_proxy_type str: Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed.
created_at str: Creation time of this environment as milliseconds since epoch.
deployment_type str: Optional. Deployment type supported by the environment. The deployment type can be set when creating the environment and cannot be changed. When you enable archive deployment, you will be prevented from performing a subset of actions within the environment, including: * Managing the deployment of API proxy or shared flow revisions * Creating, updating, or deleting resource files * Creating, updating, or deleting target servers
description str: Optional. Description of the environment.
display_name str: Optional. Display name for this environment.
forward_proxy_uri str: Optional. Url of the forward proxy to be applied to the runtime instances in this environment. Must be in the format of {scheme}://{hostname}:{port}. Note that scheme must be one of "http" or "https", and port must be supplied.
last_modified_at str: Last modification time of this environment as milliseconds since epoch.
name str: Name of the environment. Values must match the regular expression ^[.\\p{Alnum}-_]{1,255}$
node_config GoogleCloudApigeeV1NodeConfigResponse: Optional. NodeConfig of the environment.
properties GoogleCloudApigeeV1PropertiesResponse: Optional. Key-value pairs that may be used for customizing the environment.
state str: State of the environment. Values other than ACTIVE means the resource is not ready to use.

apiProxyType String: Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed.
createdAt String: Creation time of this environment as milliseconds since epoch.
deploymentType String: Optional. Deployment type supported by the environment. The deployment type can be set when creating the environment and cannot be changed. When you enable archive deployment, you will be prevented from performing a subset of actions within the environment, including: * Managing the deployment of API proxy or shared flow revisions * Creating, updating, or deleting resource files * Creating, updating, or deleting target servers
description String: Optional. Description of the environment.
displayName String: Optional. Display name for this environment.
forwardProxyUri String: Optional. Url of the forward proxy to be applied to the runtime instances in this environment. Must be in the format of {scheme}://{hostname}:{port}. Note that scheme must be one of "http" or "https", and port must be supplied.
lastModifiedAt String: Last modification time of this environment as milliseconds since epoch.
name String: Name of the environment. Values must match the regular expression ^[.\\p{Alnum}-_]{1,255}$
nodeConfig Property Map: Optional. NodeConfig of the environment.
properties Property Map: Optional. Key-value pairs that may be used for customizing the environment.
state String: State of the environment. Values other than ACTIVE means the resource is not ready to use.

Supporting Types

GoogleCloudApigeeV1NodeConfigResponse

CurrentAggregateNodeCount string: The current total number of gateway nodes that each environment currently has across all instances.
MaxNodeCount string: Optional. The maximum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended maximum number of nodes for that gateway.
MinNodeCount string: Optional. The minimum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended minimum number of nodes for that gateway.

CurrentAggregateNodeCount string: The current total number of gateway nodes that each environment currently has across all instances.
MaxNodeCount string: Optional. The maximum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended maximum number of nodes for that gateway.
MinNodeCount string: Optional. The minimum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended minimum number of nodes for that gateway.

currentAggregateNodeCount String: The current total number of gateway nodes that each environment currently has across all instances.
maxNodeCount String: Optional. The maximum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended maximum number of nodes for that gateway.
minNodeCount String: Optional. The minimum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended minimum number of nodes for that gateway.

currentAggregateNodeCount string: The current total number of gateway nodes that each environment currently has across all instances.
maxNodeCount string: Optional. The maximum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended maximum number of nodes for that gateway.
minNodeCount string: Optional. The minimum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended minimum number of nodes for that gateway.

current_aggregate_node_count str: The current total number of gateway nodes that each environment currently has across all instances.
max_node_count str: Optional. The maximum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended maximum number of nodes for that gateway.
min_node_count str: Optional. The minimum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended minimum number of nodes for that gateway.

currentAggregateNodeCount String: The current total number of gateway nodes that each environment currently has across all instances.
maxNodeCount String: Optional. The maximum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended maximum number of nodes for that gateway.
minNodeCount String: Optional. The minimum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended minimum number of nodes for that gateway.