PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/?api-version=2023-08-01-preview

Creates or updates an connectedEnvironment.

Servers

Path parameters

Name Type Required Description
connectedEnvironmentName String Yes

Name of the connectedEnvironment.

subscriptionId String Yes

The ID of the target subscription. The value must be an UUID.

resourceGroupName String Yes

The name of the resource group. The name is case insensitive.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
extendedLocation Object No

The complex type of the extended location.

extendedLocation.name String No

The name of the extended location.

extendedLocation.type String No

The type of extendedLocation.

Possible values:

  • "CustomLocation"
location String No

The geo-location where the resource lives

properties Object No

ConnectedEnvironment resource specific properties

properties.defaultDomain String No

Default Domain Name for the cluster

properties.provisioningState String No

Provisioning state of the Kubernetes Environment.

Possible values:

  • "InfrastructureSetupInProgress"
  • "Succeeded"
  • "InfrastructureSetupComplete"
  • "Canceled"
  • "Waiting"
  • "ScheduledForDelete"
  • "Failed"
  • "InitializationInProgress"
properties.daprAIConnectionString String No

Application Insights connection string used by Dapr to export Service to Service communication telemetry

properties.deploymentErrors String No

Any errors that occurred during deployment or deployment validation

properties.staticIp String No

Static IP of the connectedEnvironment

properties.customDomainConfiguration Object No

Configuration properties for apps environment custom domain

properties.customDomainConfiguration.expirationDate String No

Certificate expiration date.

properties.customDomainConfiguration.dnsSuffix String No

Dns suffix for the environment domain

properties.customDomainConfiguration.thumbprint String No

Certificate thumbprint.

properties.customDomainConfiguration.subjectName String No

Subject name of the certificate.

properties.customDomainConfiguration.certificatePassword String No

Certificate password

properties.customDomainConfiguration.certificateValue String No

PFX or PEM blob

properties.customDomainConfiguration.customDomainVerificationId String No

Id used to verify domain name ownership

tags Object No

Resource tags.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.