Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. app
  5. getConnectedEnvironment
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.app.getConnectedEnvironment

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

Get the properties of an connectedEnvironment.

Uses Azure REST API version 2024-03-01.

Other available API versions: 2022-10-01, 2022-11-01-preview, 2023-04-01-preview, 2023-05-01, 2023-05-02-preview, 2023-08-01-preview, 2023-11-02-preview, 2024-02-02-preview, 2024-08-02-preview, 2024-10-02-preview, 2025-01-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native app [ApiVersion]. See the version guide for details.

Using getConnectedEnvironment

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 getConnectedEnvironment(args: GetConnectedEnvironmentArgs, opts?: InvokeOptions): Promise<GetConnectedEnvironmentResult>
function getConnectedEnvironmentOutput(args: GetConnectedEnvironmentOutputArgs, opts?: InvokeOptions): Output<GetConnectedEnvironmentResult>
Copy
def get_connected_environment(connected_environment_name: Optional[str] = None,
                              resource_group_name: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetConnectedEnvironmentResult
def get_connected_environment_output(connected_environment_name: Optional[pulumi.Input[str]] = None,
                              resource_group_name: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetConnectedEnvironmentResult]
Copy
func LookupConnectedEnvironment(ctx *Context, args *LookupConnectedEnvironmentArgs, opts ...InvokeOption) (*LookupConnectedEnvironmentResult, error)
func LookupConnectedEnvironmentOutput(ctx *Context, args *LookupConnectedEnvironmentOutputArgs, opts ...InvokeOption) LookupConnectedEnvironmentResultOutput
Copy

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

public static class GetConnectedEnvironment 
{
    public static Task<GetConnectedEnvironmentResult> InvokeAsync(GetConnectedEnvironmentArgs args, InvokeOptions? opts = null)
    public static Output<GetConnectedEnvironmentResult> Invoke(GetConnectedEnvironmentInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetConnectedEnvironmentResult> getConnectedEnvironment(GetConnectedEnvironmentArgs args, InvokeOptions options)
public static Output<GetConnectedEnvironmentResult> getConnectedEnvironment(GetConnectedEnvironmentArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:app:getConnectedEnvironment
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ConnectedEnvironmentName
This property is required.
Changes to this property will trigger replacement.
string
Name of the connectedEnvironment.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ConnectedEnvironmentName
This property is required.
Changes to this property will trigger replacement.
string
Name of the connectedEnvironment.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
connectedEnvironmentName
This property is required.
Changes to this property will trigger replacement.
String
Name of the connectedEnvironment.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
connectedEnvironmentName
This property is required.
Changes to this property will trigger replacement.
string
Name of the connectedEnvironment.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
connected_environment_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the connectedEnvironment.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
connectedEnvironmentName
This property is required.
Changes to this property will trigger replacement.
String
Name of the connectedEnvironment.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

getConnectedEnvironment Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
DefaultDomain string
Default Domain Name for the cluster
DeploymentErrors string
Any errors that occurred during deployment or deployment validation
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Location string
The geo-location where the resource lives
Name string
The name of the resource
ProvisioningState string
Provisioning state of the Kubernetes Environment.
SystemData Pulumi.AzureNative.App.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
CustomDomainConfiguration Pulumi.AzureNative.App.Outputs.CustomDomainConfigurationResponse
Custom domain configuration for the environment
DaprAIConnectionString string
Application Insights connection string used by Dapr to export Service to Service communication telemetry
ExtendedLocation Pulumi.AzureNative.App.Outputs.ExtendedLocationResponse
The complex type of the extended location.
StaticIp string
Static IP of the connectedEnvironment
Tags Dictionary<string, string>
Resource tags.
AzureApiVersion string
The Azure API version of the resource.
DefaultDomain string
Default Domain Name for the cluster
DeploymentErrors string
Any errors that occurred during deployment or deployment validation
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Location string
The geo-location where the resource lives
Name string
The name of the resource
ProvisioningState string
Provisioning state of the Kubernetes Environment.
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
CustomDomainConfiguration CustomDomainConfigurationResponse
Custom domain configuration for the environment
DaprAIConnectionString string
Application Insights connection string used by Dapr to export Service to Service communication telemetry
ExtendedLocation ExtendedLocationResponse
The complex type of the extended location.
StaticIp string
Static IP of the connectedEnvironment
Tags map[string]string
Resource tags.
azureApiVersion String
The Azure API version of the resource.
defaultDomain String
Default Domain Name for the cluster
deploymentErrors String
Any errors that occurred during deployment or deployment validation
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location String
The geo-location where the resource lives
name String
The name of the resource
provisioningState String
Provisioning state of the Kubernetes Environment.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
customDomainConfiguration CustomDomainConfigurationResponse
Custom domain configuration for the environment
daprAIConnectionString String
Application Insights connection string used by Dapr to export Service to Service communication telemetry
extendedLocation ExtendedLocationResponse
The complex type of the extended location.
staticIp String
Static IP of the connectedEnvironment
tags Map<String,String>
Resource tags.
azureApiVersion string
The Azure API version of the resource.
defaultDomain string
Default Domain Name for the cluster
deploymentErrors string
Any errors that occurred during deployment or deployment validation
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location string
The geo-location where the resource lives
name string
The name of the resource
provisioningState string
Provisioning state of the Kubernetes Environment.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
customDomainConfiguration CustomDomainConfigurationResponse
Custom domain configuration for the environment
daprAIConnectionString string
Application Insights connection string used by Dapr to export Service to Service communication telemetry
extendedLocation ExtendedLocationResponse
The complex type of the extended location.
staticIp string
Static IP of the connectedEnvironment
tags {[key: string]: string}
Resource tags.
azure_api_version str
The Azure API version of the resource.
default_domain str
Default Domain Name for the cluster
deployment_errors str
Any errors that occurred during deployment or deployment validation
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location str
The geo-location where the resource lives
name str
The name of the resource
provisioning_state str
Provisioning state of the Kubernetes Environment.
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
custom_domain_configuration CustomDomainConfigurationResponse
Custom domain configuration for the environment
dapr_ai_connection_string str
Application Insights connection string used by Dapr to export Service to Service communication telemetry
extended_location ExtendedLocationResponse
The complex type of the extended location.
static_ip str
Static IP of the connectedEnvironment
tags Mapping[str, str]
Resource tags.
azureApiVersion String
The Azure API version of the resource.
defaultDomain String
Default Domain Name for the cluster
deploymentErrors String
Any errors that occurred during deployment or deployment validation
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location String
The geo-location where the resource lives
name String
The name of the resource
provisioningState String
Provisioning state of the Kubernetes Environment.
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
customDomainConfiguration Property Map
Custom domain configuration for the environment
daprAIConnectionString String
Application Insights connection string used by Dapr to export Service to Service communication telemetry
extendedLocation Property Map
The complex type of the extended location.
staticIp String
Static IP of the connectedEnvironment
tags Map<String>
Resource tags.

Supporting Types

CustomDomainConfigurationResponse

CustomDomainVerificationId This property is required. string
Id used to verify domain name ownership
ExpirationDate This property is required. string
Certificate expiration date.
SubjectName This property is required. string
Subject name of the certificate.
Thumbprint This property is required. string
Certificate thumbprint.
CertificatePassword string
Certificate password
CertificateValue string
PFX or PEM blob
DnsSuffix string
Dns suffix for the environment domain
CustomDomainVerificationId This property is required. string
Id used to verify domain name ownership
ExpirationDate This property is required. string
Certificate expiration date.
SubjectName This property is required. string
Subject name of the certificate.
Thumbprint This property is required. string
Certificate thumbprint.
CertificatePassword string
Certificate password
CertificateValue string
PFX or PEM blob
DnsSuffix string
Dns suffix for the environment domain
customDomainVerificationId This property is required. String
Id used to verify domain name ownership
expirationDate This property is required. String
Certificate expiration date.
subjectName This property is required. String
Subject name of the certificate.
thumbprint This property is required. String
Certificate thumbprint.
certificatePassword String
Certificate password
certificateValue String
PFX or PEM blob
dnsSuffix String
Dns suffix for the environment domain
customDomainVerificationId This property is required. string
Id used to verify domain name ownership
expirationDate This property is required. string
Certificate expiration date.
subjectName This property is required. string
Subject name of the certificate.
thumbprint This property is required. string
Certificate thumbprint.
certificatePassword string
Certificate password
certificateValue string
PFX or PEM blob
dnsSuffix string
Dns suffix for the environment domain
custom_domain_verification_id This property is required. str
Id used to verify domain name ownership
expiration_date This property is required. str
Certificate expiration date.
subject_name This property is required. str
Subject name of the certificate.
thumbprint This property is required. str
Certificate thumbprint.
certificate_password str
Certificate password
certificate_value str
PFX or PEM blob
dns_suffix str
Dns suffix for the environment domain
customDomainVerificationId This property is required. String
Id used to verify domain name ownership
expirationDate This property is required. String
Certificate expiration date.
subjectName This property is required. String
Subject name of the certificate.
thumbprint This property is required. String
Certificate thumbprint.
certificatePassword String
Certificate password
certificateValue String
PFX or PEM blob
dnsSuffix String
Dns suffix for the environment domain

ExtendedLocationResponse

Name string
The name of the extended location.
Type string
The type of the extended location.
Name string
The name of the extended location.
Type string
The type of the extended location.
name String
The name of the extended location.
type String
The type of the extended location.
name string
The name of the extended location.
type string
The type of the extended location.
name str
The name of the extended location.
type str
The type of the extended location.
name String
The name of the extended location.
type String
The type of the extended location.

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native