PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/kubeEnvironments/{name}/?api-version=2023-01-01
Description for Creates or updates a Kubernetes Environment.
Servers
- https://management.azure.com/
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
name |
String | Yes |
Name of the Kubernetes Environment. |
subscriptionId |
String | Yes |
Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). |
resourceGroupName |
String | Yes |
Name of the resource group to which the resource belongs. |
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 |
|---|---|---|---|
id |
String | No |
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
extendedLocation |
Object | No |
Extended Location. |
extendedLocation.name |
String | No |
Name of extended location. |
extendedLocation.type |
String | No |
Type of extended location. |
name |
String | No |
The name of the resource |
systemData |
Object | No |
Metadata pertaining to creation and last modification of the resource. |
systemData.createdByType |
String | No |
The type of identity that created the resource. Possible values:
|
systemData.lastModifiedAt |
String | No |
The timestamp of resource last modification (UTC) |
systemData.createdAt |
String | No |
The timestamp of resource creation (UTC). |
systemData.lastModifiedBy |
String | No |
The identity that last modified the resource. |
systemData.lastModifiedByType |
String | No |
The type of identity that last modified the resource. Possible values:
|
systemData.createdBy |
String | No |
The identity that created the resource. |
properties |
Object | No |
KubeEnvironment resource specific properties |
properties.containerAppsConfiguration |
Object | No | |
properties.containerAppsConfiguration.appSubnetResourceId |
String | No |
Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined. |
properties.containerAppsConfiguration.controlPlaneSubnetResourceId |
String | No |
Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined. |
properties.containerAppsConfiguration.platformReservedCidr |
String | No |
IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. It must not overlap with any other Subnet IP ranges. |
properties.containerAppsConfiguration.platformReservedDnsIP |
String | No |
An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server |
properties.containerAppsConfiguration.dockerBridgeCidr |
String | No |
CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the IP range defined in platformReservedCidr, if defined. |
properties.containerAppsConfiguration.daprAIInstrumentationKey |
String | No |
Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry |
properties.appLogsConfiguration |
Object | No | |
properties.appLogsConfiguration.destination |
String | No | |
properties.appLogsConfiguration.logAnalyticsConfiguration |
Object | No | |
properties.appLogsConfiguration.logAnalyticsConfiguration.sharedKey |
String | No | |
properties.appLogsConfiguration.logAnalyticsConfiguration.customerId |
String | No | |
properties.defaultDomain |
String | No |
Default Domain Name for the cluster |
properties.provisioningState |
String | No |
Provisioning state of the Kubernetes Environment. Possible values:
|
properties.deploymentErrors |
String | No |
Any errors that occurred during deployment or deployment validation |
properties.staticIp |
String | No |
Static IP of the KubeEnvironment |
properties.environmentType |
String | No |
Type of Kubernetes Environment. Only supported for Container App Environments with value as Managed |
properties.aksResourceID |
String | No | |
properties.arcConfiguration |
Object | No | |
properties.arcConfiguration.kubeConfig |
String | No | |
properties.arcConfiguration.frontEndServiceConfiguration |
Object | No | |
properties.arcConfiguration.frontEndServiceConfiguration.kind |
String | No |
Possible values:
|
properties.arcConfiguration.artifactsStorageType |
String | No |
Possible values:
|
properties.arcConfiguration.artifactStorageAccessMode |
String | No | |
properties.arcConfiguration.artifactStorageMountPath |
String | No | |
properties.arcConfiguration.artifactStorageClassName |
String | No | |
properties.arcConfiguration.artifactStorageNodeName |
String | No | |
properties.internalLoadBalancerEnabled |
Boolean | No |
Only visible within Vnet/Subnet |
type |
String | No |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
How to start integrating
- Add HTTP Task to your workflow definition.
- 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.
- Click Test request to test run your request to the API and see the API's response.