Kube Environments - Create Or Update

Serviço:

App Service

Versão da API:

2025-05-01

Descrição para Cria ou atualiza um ambiente Kubernetes.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/kubeEnvironments/{name}?api-version=2025-05-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
name	path	True	string	Nome do ambiente Kubernetes.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser um UUID.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Corpo do Pedido

Name	Necessário	Tipo	Description
location	True	string	A geolocalização onde o recurso vive
extendedLocation		ExtendedLocation	Localização estendida.
kind		string	Tipo de recurso.
properties.aksResourceID		string
properties.appLogsConfiguration		AppLogsConfiguration	Configuração de cluster que permite que o daemon de log exporte logs de aplicativos para um destino. Atualmente, apenas "log-analytics" é suportado
properties.arcConfiguration		ArcConfiguration	Configuração de cluster que determina os tipos de componentes de cluster ARC. Por exemplo: Escolhendo entre o tipo BuildService, FrontEnd Service ArtifactsStorageType etc.
properties.containerAppsConfiguration		ContainerAppsConfiguration	Configuração de cluster para ambientes de aplicativos de contêiner para configurar a chave de instrumentação Dapr e a configuração de VNET
properties.environmentType		string	Tipo de ambiente Kubernetes. Suportado apenas para Ambientes de Aplicativos de Contêiner com valor como Gerenciado
properties.internalLoadBalancerEnabled		boolean	Visível apenas em Vnet/Subnet
properties.staticIp		string	IP estático do KubeEnvironment
tags		object	Tags de recursos.

Respostas

Name	Tipo	Description
200 OK	KubeEnvironment	Operação de atualização do recurso 'KubeEnvironment' bem-sucedida
201 Created	KubeEnvironment	Recurso 'KubeEnvironment' criar operação bem-sucedida Cabeçalhos Location: string Retry-After: integer
Other Status Codes	DefaultErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

Create kube environments

Pedido de amostra

HTTP

PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.Web/kubeEnvironments/testkubeenv?api-version=2025-05-01

{
  "location": "East US",
  "properties": {
    "staticIp": "1.2.3.4"
  }
}

Java

import com.azure.resourcemanager.appservice.fluent.models.KubeEnvironmentInner;

/**
 * Samples for KubeEnvironments CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-05-01/KubeEnvironments_CreateOrUpdate.json
     */
    /**
     * Sample code: Create kube environments.
     * 
     * @param manager Entry point to AppServiceManager.
     */
    public static void createKubeEnvironments(com.azure.resourcemanager.appservice.AppServiceManager manager) {
        manager.serviceClient().getKubeEnvironments().createOrUpdate("examplerg", "testkubeenv",
            new KubeEnvironmentInner().withLocation("East US").withStaticIp("1.2.3.4"),
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armappservice_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v6"
)

// Generated from example definition: 2025-05-01/KubeEnvironments_CreateOrUpdate.json
func ExampleKubeEnvironmentsClient_BeginCreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappservice.NewClientFactory("34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewKubeEnvironmentsClient().BeginCreateOrUpdate(ctx, "examplerg", "testkubeenv", armappservice.KubeEnvironment{
		Location: to.Ptr("East US"),
		Properties: &armappservice.KubeEnvironmentProperties{
			StaticIP: to.Ptr("1.2.3.4"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armappservice.KubeEnvironmentsClientCreateOrUpdateResponse{
	// 	KubeEnvironment: &armappservice.KubeEnvironment{
	// 		Name: to.Ptr("testkubeenv"),
	// 		Type: to.Ptr("Microsoft.Web/kubeEnvironments"),
	// 		ExtendedLocation: &armappservice.ExtendedLocation{
	// 			Name: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation"),
	// 			Type: to.Ptr("customLocation"),
	// 		},
	// 		ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.Web/kubeEnvironments/testkubeenv"),
	// 		Location: to.Ptr("East US"),
	// 		Properties: &armappservice.KubeEnvironmentProperties{
	// 			AksResourceID: to.Ptr("test"),
	// 			DefaultDomain: to.Ptr("testkubeenv.k4apps.io"),
	// 			InternalLoadBalancerEnabled: to.Ptr(false),
	// 			ProvisioningState: to.Ptr(armappservice.KubeEnvironmentProvisioningStateSucceeded),
	// 			StaticIP: to.Ptr("1.2.3.4"),
	// 		},
	// 		Tags: map[string]*string{
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta da amostra

Código de estado:

200

{
  "name": "testkubeenv",
  "type": "Microsoft.Web/kubeEnvironments",
  "extendedLocation": {
    "name": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation",
    "type": "customLocation"
  },
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.Web/kubeEnvironments/testkubeenv",
  "location": "East US",
  "properties": {
    "aksResourceID": "test",
    "appLogsConfiguration": null,
    "arcConfiguration": null,
    "defaultDomain": "testkubeenv.k4apps.io",
    "deploymentErrors": null,
    "internalLoadBalancerEnabled": false,
    "provisioningState": "Succeeded",
    "staticIp": "1.2.3.4"
  },
  "tags": {}
}

Código de estado:

201

{
  "name": "testkubeenv",
  "type": "Microsoft.Web/kubeEnvironments",
  "extendedLocation": {
    "name": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation",
    "type": "customLocation"
  },
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.Web/kubeEnvironments/testkubeenv",
  "location": "East US",
  "properties": {
    "aksResourceID": "test",
    "appLogsConfiguration": null,
    "arcConfiguration": null,
    "defaultDomain": "testkubeenv.k4apps.io",
    "deploymentErrors": null,
    "internalLoadBalancerEnabled": false,
    "provisioningState": "InitializationInProgress",
    "staticIp": "1.2.3.4"
  },
  "tags": {}
}

Definições

Name	Description
AppLogsConfiguration
ArcConfiguration
ContainerAppsConfiguration
createdByType	O tipo de identidade que criou o recurso.
DefaultErrorResponse	Resposta de erro do Serviço de Aplicativo.
DefaultErrorResponseError	Modelo de erro.
DefaultErrorResponseErrorDetailsItem	Erros detalhados.
ExtendedLocation	Localização estendida.
FrontEndConfiguration
FrontEndServiceType
KubeEnvironment	Um cluster Kubernetes especializado para cargas de trabalho da Web pelo Serviço de Aplicativo do Azure
KubeEnvironmentProvisioningState	Estado de provisionamento do ambiente Kubernetes.
LogAnalyticsConfiguration
StorageType
systemData	Metadados referentes à criação e última modificação do recurso.

AppLogsConfiguration

Object

Name	Tipo	Description
destination	string
logAnalyticsConfiguration	LogAnalyticsConfiguration

ArcConfiguration

Object

Name	Tipo	Description
artifactStorageAccessMode	string
artifactStorageClassName	string
artifactStorageMountPath	string
artifactStorageNodeName	string
artifactsStorageType	StorageType
frontEndServiceConfiguration	FrontEndConfiguration
kubeConfig	string (password)

ContainerAppsConfiguration

Object

Name	Tipo	Description
appSubnetResourceId	string	ID de recurso de uma sub-rede para componentes de infraestrutura do plano de controle. Essa sub-rede deve estar na mesma VNET que a sub-rede definida em appSubnetResourceId. Não deve sobrepor-se ao intervalo de IP definido em platformReservedCidr, se definido.
controlPlaneSubnetResourceId	string	ID de recurso de uma sub-rede para componentes de infraestrutura do plano de controle. Essa sub-rede deve estar na mesma VNET que a sub-rede definida em appSubnetResourceId. Não deve sobrepor-se ao intervalo de IP definido em platformReservedCidr, se definido.
daprAIInstrumentationKey	string	Chave de instrumentação do Azure Monitor usada pelo Dapr para exportar telemetria de comunicação de Serviço a Serviço
dockerBridgeCidr	string	Intervalo de IP de notação CIDR atribuído à rede de ponte do Docker. Ele não deve se sobrepor a nenhum intervalo de IP de sub-rede ou ao intervalo de IP definido em platformReservedCidr, se definido.
platformReservedCidr	string	Intervalo de IP na notação CIDR que pode ser reservado para endereços IP de infraestrutura de ambiente. Ele não deve se sobrepor a nenhum outro intervalo IP de sub-rede.
platformReservedDnsIP	string	Um endereço IP do intervalo de IP definido por platformReservedCidr que será reservado para o servidor DNS interno

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

DefaultErrorResponse

Object

Resposta de erro do Serviço de Aplicativo.

Name	Tipo	Description
error	DefaultErrorResponseError	Modelo de erro.

DefaultErrorResponseError

Object

Modelo de erro.

Name	Tipo	Description
code	string	String padronizada para identificar programaticamente o erro.
details	DefaultErrorResponseErrorDetailsItem[]	Erros detalhados.
innererror	string	Mais informações para depurar erro.
message	string	Descrição detalhada do erro e informações de depuração.
target	string	Descrição detalhada do erro e informações de depuração.

DefaultErrorResponseErrorDetailsItem

Object

Erros detalhados.

Name	Tipo	Description
code	string	String padronizada para identificar programaticamente o erro.
message	string	Descrição detalhada do erro e informações de depuração.
target	string	Descrição detalhada do erro e informações de depuração.

ExtendedLocation

Object

Localização estendida.

Name	Tipo	Description
name	string	Nome do local estendido.
type	string	Tipo de local estendido.

FrontEndConfiguration

Object

Name	Tipo	Description
kind	FrontEndServiceType

FrontEndServiceType

Enumeração

Valor	Description
NodePort
LoadBalancer

KubeEnvironment

Object

Um cluster Kubernetes especializado para cargas de trabalho da Web pelo Serviço de Aplicativo do Azure

Name	Tipo	Description
extendedLocation	ExtendedLocation	Localização estendida.
id	string (arm-id)	ID de recurso totalmente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string	Tipo de recurso.
location	string	A geolocalização onde o recurso vive
name	string	O nome do recurso
properties.aksResourceID	string
properties.appLogsConfiguration	AppLogsConfiguration	Configuração de cluster que permite que o daemon de log exporte logs de aplicativos para um destino. Atualmente, apenas "log-analytics" é suportado
properties.arcConfiguration	ArcConfiguration	Configuração de cluster que determina os tipos de componentes de cluster ARC. Por exemplo: Escolhendo entre o tipo BuildService, FrontEnd Service ArtifactsStorageType etc.
properties.containerAppsConfiguration	ContainerAppsConfiguration	Configuração de cluster para ambientes de aplicativos de contêiner para configurar a chave de instrumentação Dapr e a configuração de VNET
properties.defaultDomain	string	Nome de domínio padrão para o cluster
properties.deploymentErrors	string	Quaisquer erros que ocorreram durante a implantação ou validação da implantação
properties.environmentType	string	Tipo de ambiente Kubernetes. Suportado apenas para Ambientes de Aplicativos de Contêiner com valor como Gerenciado
properties.internalLoadBalancerEnabled	boolean	Visível apenas em Vnet/Subnet
properties.provisioningState	KubeEnvironmentProvisioningState	Estado de provisionamento do ambiente Kubernetes.
properties.staticIp	string	IP estático do KubeEnvironment
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
tags	object	Tags de recursos.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

KubeEnvironmentProvisioningState

Enumeração

Estado de provisionamento do ambiente Kubernetes.

Valor	Description
Succeeded
Failed
Canceled
Waiting
InitializationInProgress
InfrastructureSetupInProgress
InfrastructureSetupComplete
ScheduledForDelete
UpgradeRequested
UpgradeFailed

LogAnalyticsConfiguration

Object

Name	Tipo	Description
customerId	string
sharedKey	string (password)

StorageType

Enumeração

Valor	Description
LocalNode
NetworkFileSystem

systemData

Object

Metadados referentes à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.