1. Packages
  2. Azure Native
  3. API Docs
  4. web
  5. getAppServiceEnvironment
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.46.0 published on Friday, Jun 21, 2024 by Pulumi

azure-native.web.getAppServiceEnvironment

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.46.0 published on Friday, Jun 21, 2024 by Pulumi

    Description for Get the properties of an App Service Environment. Azure REST API version: 2022-09-01.

    Other available API versions: 2019-08-01, 2020-10-01, 2021-01-15, 2023-01-01, 2023-12-01.

    Using getAppServiceEnvironment

    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 getAppServiceEnvironment(args: GetAppServiceEnvironmentArgs, opts?: InvokeOptions): Promise<GetAppServiceEnvironmentResult>
    function getAppServiceEnvironmentOutput(args: GetAppServiceEnvironmentOutputArgs, opts?: InvokeOptions): Output<GetAppServiceEnvironmentResult>
    def get_app_service_environment(name: Optional[str] = None,
                                    resource_group_name: Optional[str] = None,
                                    opts: Optional[InvokeOptions] = None) -> GetAppServiceEnvironmentResult
    def get_app_service_environment_output(name: Optional[pulumi.Input[str]] = None,
                                    resource_group_name: Optional[pulumi.Input[str]] = None,
                                    opts: Optional[InvokeOptions] = None) -> Output[GetAppServiceEnvironmentResult]
    func LookupAppServiceEnvironment(ctx *Context, args *LookupAppServiceEnvironmentArgs, opts ...InvokeOption) (*LookupAppServiceEnvironmentResult, error)
    func LookupAppServiceEnvironmentOutput(ctx *Context, args *LookupAppServiceEnvironmentOutputArgs, opts ...InvokeOption) LookupAppServiceEnvironmentResultOutput

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

    public static class GetAppServiceEnvironment 
    {
        public static Task<GetAppServiceEnvironmentResult> InvokeAsync(GetAppServiceEnvironmentArgs args, InvokeOptions? opts = null)
        public static Output<GetAppServiceEnvironmentResult> Invoke(GetAppServiceEnvironmentInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAppServiceEnvironmentResult> getAppServiceEnvironment(GetAppServiceEnvironmentArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:web:getAppServiceEnvironment
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    Name of the App Service Environment.
    ResourceGroupName string
    Name of the resource group to which the resource belongs.
    Name string
    Name of the App Service Environment.
    ResourceGroupName string
    Name of the resource group to which the resource belongs.
    name String
    Name of the App Service Environment.
    resourceGroupName String
    Name of the resource group to which the resource belongs.
    name string
    Name of the App Service Environment.
    resourceGroupName string
    Name of the resource group to which the resource belongs.
    name str
    Name of the App Service Environment.
    resource_group_name str
    Name of the resource group to which the resource belongs.
    name String
    Name of the App Service Environment.
    resourceGroupName String
    Name of the resource group to which the resource belongs.

    getAppServiceEnvironment Result

    The following output properties are available:

    HasLinuxWorkers bool
    Flag that displays whether an ASE has linux workers or not
    Id string
    Resource Id.
    Location string
    Resource Location.
    MaximumNumberOfMachines int
    Maximum number of VMs in the App Service Environment.
    MultiRoleCount int
    Number of front-end instances.
    Name string
    Resource Name.
    ProvisioningState string
    Provisioning state of the App Service Environment.
    Status string
    Current status of the App Service Environment.
    Suspended bool
    true if the App Service Environment is suspended; otherwise, false. The environment can be suspended, e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).
    Type string
    Resource type.
    UpgradeAvailability string
    Whether an upgrade is available for this App Service Environment.
    VirtualNetwork Pulumi.AzureNative.Web.Outputs.VirtualNetworkProfileResponse
    Description of the Virtual Network.
    ClusterSettings List<Pulumi.AzureNative.Web.Outputs.NameValuePairResponse>
    Custom settings for changing the behavior of the App Service Environment.
    CustomDnsSuffixConfiguration Pulumi.AzureNative.Web.Outputs.CustomDnsSuffixConfigurationResponse
    Full view of the custom domain suffix configuration for ASEv3.
    DedicatedHostCount int
    Dedicated Host Count
    DnsSuffix string
    DNS suffix of the App Service Environment.
    FrontEndScaleFactor int
    Scale factor for front-ends.
    InternalLoadBalancingMode string
    Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.
    IpsslAddressCount int
    Number of IP SSL addresses reserved for the App Service Environment.
    Kind string
    Kind of resource.
    MultiSize string
    Front-end VM size, e.g. "Medium", "Large".
    NetworkingConfiguration Pulumi.AzureNative.Web.Outputs.AseV3NetworkingConfigurationResponse
    Full view of networking configuration for an ASE.
    Tags Dictionary<string, string>
    Resource tags.
    UpgradePreference string
    Upgrade Preference
    UserWhitelistedIpRanges List<string>
    User added ip ranges to whitelist on ASE db
    ZoneRedundant bool
    Whether or not this App Service Environment is zone-redundant.
    HasLinuxWorkers bool
    Flag that displays whether an ASE has linux workers or not
    Id string
    Resource Id.
    Location string
    Resource Location.
    MaximumNumberOfMachines int
    Maximum number of VMs in the App Service Environment.
    MultiRoleCount int
    Number of front-end instances.
    Name string
    Resource Name.
    ProvisioningState string
    Provisioning state of the App Service Environment.
    Status string
    Current status of the App Service Environment.
    Suspended bool
    true if the App Service Environment is suspended; otherwise, false. The environment can be suspended, e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).
    Type string
    Resource type.
    UpgradeAvailability string
    Whether an upgrade is available for this App Service Environment.
    VirtualNetwork VirtualNetworkProfileResponse
    Description of the Virtual Network.
    ClusterSettings []NameValuePairResponse
    Custom settings for changing the behavior of the App Service Environment.
    CustomDnsSuffixConfiguration CustomDnsSuffixConfigurationResponse
    Full view of the custom domain suffix configuration for ASEv3.
    DedicatedHostCount int
    Dedicated Host Count
    DnsSuffix string
    DNS suffix of the App Service Environment.
    FrontEndScaleFactor int
    Scale factor for front-ends.
    InternalLoadBalancingMode string
    Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.
    IpsslAddressCount int
    Number of IP SSL addresses reserved for the App Service Environment.
    Kind string
    Kind of resource.
    MultiSize string
    Front-end VM size, e.g. "Medium", "Large".
    NetworkingConfiguration AseV3NetworkingConfigurationResponse
    Full view of networking configuration for an ASE.
    Tags map[string]string
    Resource tags.
    UpgradePreference string
    Upgrade Preference
    UserWhitelistedIpRanges []string
    User added ip ranges to whitelist on ASE db
    ZoneRedundant bool
    Whether or not this App Service Environment is zone-redundant.
    hasLinuxWorkers Boolean
    Flag that displays whether an ASE has linux workers or not
    id String
    Resource Id.
    location String
    Resource Location.
    maximumNumberOfMachines Integer
    Maximum number of VMs in the App Service Environment.
    multiRoleCount Integer
    Number of front-end instances.
    name String
    Resource Name.
    provisioningState String
    Provisioning state of the App Service Environment.
    status String
    Current status of the App Service Environment.
    suspended Boolean
    true if the App Service Environment is suspended; otherwise, false. The environment can be suspended, e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).
    type String
    Resource type.
    upgradeAvailability String
    Whether an upgrade is available for this App Service Environment.
    virtualNetwork VirtualNetworkProfileResponse
    Description of the Virtual Network.
    clusterSettings List<NameValuePairResponse>
    Custom settings for changing the behavior of the App Service Environment.
    customDnsSuffixConfiguration CustomDnsSuffixConfigurationResponse
    Full view of the custom domain suffix configuration for ASEv3.
    dedicatedHostCount Integer
    Dedicated Host Count
    dnsSuffix String
    DNS suffix of the App Service Environment.
    frontEndScaleFactor Integer
    Scale factor for front-ends.
    internalLoadBalancingMode String
    Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.
    ipsslAddressCount Integer
    Number of IP SSL addresses reserved for the App Service Environment.
    kind String
    Kind of resource.
    multiSize String
    Front-end VM size, e.g. "Medium", "Large".
    networkingConfiguration AseV3NetworkingConfigurationResponse
    Full view of networking configuration for an ASE.
    tags Map<String,String>
    Resource tags.
    upgradePreference String
    Upgrade Preference
    userWhitelistedIpRanges List<String>
    User added ip ranges to whitelist on ASE db
    zoneRedundant Boolean
    Whether or not this App Service Environment is zone-redundant.
    hasLinuxWorkers boolean
    Flag that displays whether an ASE has linux workers or not
    id string
    Resource Id.
    location string
    Resource Location.
    maximumNumberOfMachines number
    Maximum number of VMs in the App Service Environment.
    multiRoleCount number
    Number of front-end instances.
    name string
    Resource Name.
    provisioningState string
    Provisioning state of the App Service Environment.
    status string
    Current status of the App Service Environment.
    suspended boolean
    true if the App Service Environment is suspended; otherwise, false. The environment can be suspended, e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).
    type string
    Resource type.
    upgradeAvailability string
    Whether an upgrade is available for this App Service Environment.
    virtualNetwork VirtualNetworkProfileResponse
    Description of the Virtual Network.
    clusterSettings NameValuePairResponse[]
    Custom settings for changing the behavior of the App Service Environment.
    customDnsSuffixConfiguration CustomDnsSuffixConfigurationResponse
    Full view of the custom domain suffix configuration for ASEv3.
    dedicatedHostCount number
    Dedicated Host Count
    dnsSuffix string
    DNS suffix of the App Service Environment.
    frontEndScaleFactor number
    Scale factor for front-ends.
    internalLoadBalancingMode string
    Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.
    ipsslAddressCount number
    Number of IP SSL addresses reserved for the App Service Environment.
    kind string
    Kind of resource.
    multiSize string
    Front-end VM size, e.g. "Medium", "Large".
    networkingConfiguration AseV3NetworkingConfigurationResponse
    Full view of networking configuration for an ASE.
    tags {[key: string]: string}
    Resource tags.
    upgradePreference string
    Upgrade Preference
    userWhitelistedIpRanges string[]
    User added ip ranges to whitelist on ASE db
    zoneRedundant boolean
    Whether or not this App Service Environment is zone-redundant.
    has_linux_workers bool
    Flag that displays whether an ASE has linux workers or not
    id str
    Resource Id.
    location str
    Resource Location.
    maximum_number_of_machines int
    Maximum number of VMs in the App Service Environment.
    multi_role_count int
    Number of front-end instances.
    name str
    Resource Name.
    provisioning_state str
    Provisioning state of the App Service Environment.
    status str
    Current status of the App Service Environment.
    suspended bool
    true if the App Service Environment is suspended; otherwise, false. The environment can be suspended, e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).
    type str
    Resource type.
    upgrade_availability str
    Whether an upgrade is available for this App Service Environment.
    virtual_network VirtualNetworkProfileResponse
    Description of the Virtual Network.
    cluster_settings Sequence[NameValuePairResponse]
    Custom settings for changing the behavior of the App Service Environment.
    custom_dns_suffix_configuration CustomDnsSuffixConfigurationResponse
    Full view of the custom domain suffix configuration for ASEv3.
    dedicated_host_count int
    Dedicated Host Count
    dns_suffix str
    DNS suffix of the App Service Environment.
    front_end_scale_factor int
    Scale factor for front-ends.
    internal_load_balancing_mode str
    Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.
    ipssl_address_count int
    Number of IP SSL addresses reserved for the App Service Environment.
    kind str
    Kind of resource.
    multi_size str
    Front-end VM size, e.g. "Medium", "Large".
    networking_configuration AseV3NetworkingConfigurationResponse
    Full view of networking configuration for an ASE.
    tags Mapping[str, str]
    Resource tags.
    upgrade_preference str
    Upgrade Preference
    user_whitelisted_ip_ranges Sequence[str]
    User added ip ranges to whitelist on ASE db
    zone_redundant bool
    Whether or not this App Service Environment is zone-redundant.
    hasLinuxWorkers Boolean
    Flag that displays whether an ASE has linux workers or not
    id String
    Resource Id.
    location String
    Resource Location.
    maximumNumberOfMachines Number
    Maximum number of VMs in the App Service Environment.
    multiRoleCount Number
    Number of front-end instances.
    name String
    Resource Name.
    provisioningState String
    Provisioning state of the App Service Environment.
    status String
    Current status of the App Service Environment.
    suspended Boolean
    true if the App Service Environment is suspended; otherwise, false. The environment can be suspended, e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).
    type String
    Resource type.
    upgradeAvailability String
    Whether an upgrade is available for this App Service Environment.
    virtualNetwork Property Map
    Description of the Virtual Network.
    clusterSettings List<Property Map>
    Custom settings for changing the behavior of the App Service Environment.
    customDnsSuffixConfiguration Property Map
    Full view of the custom domain suffix configuration for ASEv3.
    dedicatedHostCount Number
    Dedicated Host Count
    dnsSuffix String
    DNS suffix of the App Service Environment.
    frontEndScaleFactor Number
    Scale factor for front-ends.
    internalLoadBalancingMode String
    Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.
    ipsslAddressCount Number
    Number of IP SSL addresses reserved for the App Service Environment.
    kind String
    Kind of resource.
    multiSize String
    Front-end VM size, e.g. "Medium", "Large".
    networkingConfiguration Property Map
    Full view of networking configuration for an ASE.
    tags Map<String>
    Resource tags.
    upgradePreference String
    Upgrade Preference
    userWhitelistedIpRanges List<String>
    User added ip ranges to whitelist on ASE db
    zoneRedundant Boolean
    Whether or not this App Service Environment is zone-redundant.

    Supporting Types

    AseV3NetworkingConfigurationResponse

    ExternalInboundIpAddresses List<string>
    Id string
    Resource Id.
    InternalInboundIpAddresses List<string>
    LinuxOutboundIpAddresses List<string>
    Name string
    Resource Name.
    Type string
    Resource type.
    WindowsOutboundIpAddresses List<string>
    AllowNewPrivateEndpointConnections bool
    Property to enable and disable new private endpoint connection creation on ASE
    FtpEnabled bool
    Property to enable and disable FTP on ASEV3
    InboundIpAddressOverride string
    Customer provided Inbound IP Address. Only able to be set on Ase create.
    Kind string
    Kind of resource.
    RemoteDebugEnabled bool
    Property to enable and disable Remote Debug on ASEV3
    ExternalInboundIpAddresses []string
    Id string
    Resource Id.
    InternalInboundIpAddresses []string
    LinuxOutboundIpAddresses []string
    Name string
    Resource Name.
    Type string
    Resource type.
    WindowsOutboundIpAddresses []string
    AllowNewPrivateEndpointConnections bool
    Property to enable and disable new private endpoint connection creation on ASE
    FtpEnabled bool
    Property to enable and disable FTP on ASEV3
    InboundIpAddressOverride string
    Customer provided Inbound IP Address. Only able to be set on Ase create.
    Kind string
    Kind of resource.
    RemoteDebugEnabled bool
    Property to enable and disable Remote Debug on ASEV3
    externalInboundIpAddresses List<String>
    id String
    Resource Id.
    internalInboundIpAddresses List<String>
    linuxOutboundIpAddresses List<String>
    name String
    Resource Name.
    type String
    Resource type.
    windowsOutboundIpAddresses List<String>
    allowNewPrivateEndpointConnections Boolean
    Property to enable and disable new private endpoint connection creation on ASE
    ftpEnabled Boolean
    Property to enable and disable FTP on ASEV3
    inboundIpAddressOverride String
    Customer provided Inbound IP Address. Only able to be set on Ase create.
    kind String
    Kind of resource.
    remoteDebugEnabled Boolean
    Property to enable and disable Remote Debug on ASEV3
    externalInboundIpAddresses string[]
    id string
    Resource Id.
    internalInboundIpAddresses string[]
    linuxOutboundIpAddresses string[]
    name string
    Resource Name.
    type string
    Resource type.
    windowsOutboundIpAddresses string[]
    allowNewPrivateEndpointConnections boolean
    Property to enable and disable new private endpoint connection creation on ASE
    ftpEnabled boolean
    Property to enable and disable FTP on ASEV3
    inboundIpAddressOverride string
    Customer provided Inbound IP Address. Only able to be set on Ase create.
    kind string
    Kind of resource.
    remoteDebugEnabled boolean
    Property to enable and disable Remote Debug on ASEV3
    external_inbound_ip_addresses Sequence[str]
    id str
    Resource Id.
    internal_inbound_ip_addresses Sequence[str]
    linux_outbound_ip_addresses Sequence[str]
    name str
    Resource Name.
    type str
    Resource type.
    windows_outbound_ip_addresses Sequence[str]
    allow_new_private_endpoint_connections bool
    Property to enable and disable new private endpoint connection creation on ASE
    ftp_enabled bool
    Property to enable and disable FTP on ASEV3
    inbound_ip_address_override str
    Customer provided Inbound IP Address. Only able to be set on Ase create.
    kind str
    Kind of resource.
    remote_debug_enabled bool
    Property to enable and disable Remote Debug on ASEV3
    externalInboundIpAddresses List<String>
    id String
    Resource Id.
    internalInboundIpAddresses List<String>
    linuxOutboundIpAddresses List<String>
    name String
    Resource Name.
    type String
    Resource type.
    windowsOutboundIpAddresses List<String>
    allowNewPrivateEndpointConnections Boolean
    Property to enable and disable new private endpoint connection creation on ASE
    ftpEnabled Boolean
    Property to enable and disable FTP on ASEV3
    inboundIpAddressOverride String
    Customer provided Inbound IP Address. Only able to be set on Ase create.
    kind String
    Kind of resource.
    remoteDebugEnabled Boolean
    Property to enable and disable Remote Debug on ASEV3

    CustomDnsSuffixConfigurationResponse

    Id string
    Resource Id.
    Name string
    Resource Name.
    ProvisioningDetails string
    ProvisioningState string
    Type string
    Resource type.
    CertificateUrl string
    The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix.
    DnsSuffix string
    The default custom domain suffix to use for all sites deployed on the ASE.
    KeyVaultReferenceIdentity string
    The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available.
    Kind string
    Kind of resource.
    Id string
    Resource Id.
    Name string
    Resource Name.
    ProvisioningDetails string
    ProvisioningState string
    Type string
    Resource type.
    CertificateUrl string
    The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix.
    DnsSuffix string
    The default custom domain suffix to use for all sites deployed on the ASE.
    KeyVaultReferenceIdentity string
    The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available.
    Kind string
    Kind of resource.
    id String
    Resource Id.
    name String
    Resource Name.
    provisioningDetails String
    provisioningState String
    type String
    Resource type.
    certificateUrl String
    The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix.
    dnsSuffix String
    The default custom domain suffix to use for all sites deployed on the ASE.
    keyVaultReferenceIdentity String
    The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available.
    kind String
    Kind of resource.
    id string
    Resource Id.
    name string
    Resource Name.
    provisioningDetails string
    provisioningState string
    type string
    Resource type.
    certificateUrl string
    The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix.
    dnsSuffix string
    The default custom domain suffix to use for all sites deployed on the ASE.
    keyVaultReferenceIdentity string
    The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available.
    kind string
    Kind of resource.
    id str
    Resource Id.
    name str
    Resource Name.
    provisioning_details str
    provisioning_state str
    type str
    Resource type.
    certificate_url str
    The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix.
    dns_suffix str
    The default custom domain suffix to use for all sites deployed on the ASE.
    key_vault_reference_identity str
    The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available.
    kind str
    Kind of resource.
    id String
    Resource Id.
    name String
    Resource Name.
    provisioningDetails String
    provisioningState String
    type String
    Resource type.
    certificateUrl String
    The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix.
    dnsSuffix String
    The default custom domain suffix to use for all sites deployed on the ASE.
    keyVaultReferenceIdentity String
    The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available.
    kind String
    Kind of resource.

    NameValuePairResponse

    Name string
    Pair name.
    Value string
    Pair value.
    Name string
    Pair name.
    Value string
    Pair value.
    name String
    Pair name.
    value String
    Pair value.
    name string
    Pair name.
    value string
    Pair value.
    name str
    Pair name.
    value str
    Pair value.
    name String
    Pair name.
    value String
    Pair value.

    VirtualNetworkProfileResponse

    Id string
    Resource id of the Virtual Network.
    Name string
    Name of the Virtual Network (read-only).
    Type string
    Resource type of the Virtual Network (read-only).
    Subnet string
    Subnet within the Virtual Network.
    Id string
    Resource id of the Virtual Network.
    Name string
    Name of the Virtual Network (read-only).
    Type string
    Resource type of the Virtual Network (read-only).
    Subnet string
    Subnet within the Virtual Network.
    id String
    Resource id of the Virtual Network.
    name String
    Name of the Virtual Network (read-only).
    type String
    Resource type of the Virtual Network (read-only).
    subnet String
    Subnet within the Virtual Network.
    id string
    Resource id of the Virtual Network.
    name string
    Name of the Virtual Network (read-only).
    type string
    Resource type of the Virtual Network (read-only).
    subnet string
    Subnet within the Virtual Network.
    id str
    Resource id of the Virtual Network.
    name str
    Name of the Virtual Network (read-only).
    type str
    Resource type of the Virtual Network (read-only).
    subnet str
    Subnet within the Virtual Network.
    id String
    Resource id of the Virtual Network.
    name String
    Name of the Virtual Network (read-only).
    type String
    Resource type of the Virtual Network (read-only).
    subnet String
    Subnet within the Virtual Network.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.46.0 published on Friday, Jun 21, 2024 by Pulumi