Kube Environments - Create Or Update

Referência

Serviço:: App Service

Versão da API:: 2024-11-01

Descrição para Criar ou atualizar um Ambiente do Kubernetes.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
name	path	True	string	Nome do Ambiente do Kubernetes.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+[^\.]$	Nome do grupo de recursos ao qual o recurso pertence.
subscriptionId	path	True	string	Sua ID da assinatura do Azure. Esta é uma cadeia de caracteres formatada por GUID (por exemplo, 000000000-0000-0000-0000-000000000000000).
api-version	query	True	string	Versão da API

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
location	True	string	Local do recurso.
extendedLocation		ExtendedLocation	Local Estendido.
kind		string	Tipo de recurso. Se o recurso for um aplicativo, você poderá consultar https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference para obter detalhes de valores com suporte para tipo.
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, há suporte apenas para "log-analytics"
properties.arcConfiguration		ArcConfiguration	Configuração de cluster que determina os tipos de componentes do cluster ARC. Por exemplo: escolhendo entre o tipo BuildService, o ArtifactsStorageType do Serviço front-end 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 da VNET
properties.environmentType		string	Tipo de Ambiente do Kubernetes. Com suporte apenas para ambientes de aplicativo de contêiner com valor como Gerenciado
properties.internalLoadBalancerEnabled		boolean	Somente visível dentro da Vnet/Sub-rede
properties.staticIp		string	IP estático do KubeEnvironment
tags		object	Tags de recursos.

Respostas

Nome	Tipo	Description
200 OK	KubeEnvironment	OKEY
201 Created	KubeEnvironment	Criado
Other Status Codes	DefaultErrorResponse	Resposta de erro do Serviço de Aplicativo.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Create kube environments

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

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.AppService;

// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/KubeEnvironments_CreateOrUpdate.json
// this example is just showing the usage of "KubeEnvironments_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "examplerg";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this KubeEnvironmentResource
KubeEnvironmentCollection collection = resourceGroupResource.GetKubeEnvironments();

// invoke the operation
string name = "testkubeenv";
KubeEnvironmentData data = new KubeEnvironmentData(new AzureLocation("East US"))
{
    StaticIP = "1.2.3.4",
};
ArmOperation<KubeEnvironmentResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, name, data);
KubeEnvironmentResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
KubeEnvironmentData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Resposta de exemplo

Código de status:: 200

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

Código de status:: 201

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

Definições

Nome	Description
AppLogsConfiguration
ArcConfiguration
ContainerAppsConfiguration
DefaultErrorResponse	Resposta de erro do Serviço de Aplicativo.
Details
Error	Modelo de erro.
ExtendedLocation	Local Estendido.
FrontEndConfiguration
FrontEndServiceType
KubeEnvironment	Um cluster do Kubernetes especializado em cargas de trabalho da Web pelo Serviço de Aplicativo do Azure
KubeEnvironmentProvisioningState	Estado de provisionamento do Ambiente do Kubernetes.
LogAnalyticsConfiguration
StorageType

AppLogsConfiguration

Objeto

Nome	Tipo	Description
destination	string
logAnalyticsConfiguration	LogAnalyticsConfiguration

ArcConfiguration

Objeto

Nome	Tipo	Description
artifactStorageAccessMode	string
artifactStorageClassName	string
artifactStorageMountPath	string
artifactStorageNodeName	string
artifactsStorageType	StorageType
frontEndServiceConfiguration	FrontEndConfiguration
kubeConfig	string

ContainerAppsConfiguration

Objeto

Nome	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 se sobrepor 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 se sobrepor ao intervalo de IP definido em platformReservedCidr, se definido.
daprAIInstrumentationKey	string	Chave de instrumentação do Azure Monitor usada pela Dapr para exportar a telemetria de comunicação do Serviço para o 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 de 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

DefaultErrorResponse

Objeto

Resposta de erro do Serviço de Aplicativo.

Nome	Tipo	Description
error	Error	Modelo de erro.

Details

Objeto

Nome	Tipo	Description
code	string	Cadeia de caracteres padronizada para identificar programaticamente o erro.
message	string	Informações detalhadas de descrição e depuração de erros.
target	string	Informações detalhadas de descrição e depuração de erros.

Error

Objeto

Modelo de erro.

Nome	Tipo	Description
code	string	Cadeia de caracteres padronizada para identificar programaticamente o erro.
details	Details[]	Erros detalhados.
innererror	string	Mais informações para depurar o erro.
message	string	Informações detalhadas de descrição e depuração de erros.
target	string	Informações detalhadas de descrição e depuração de erros.

ExtendedLocation

Objeto

Local Estendido.

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

FrontEndConfiguration

Objeto

Nome	Tipo	Description
kind	FrontEndServiceType

FrontEndServiceType

Enumeração

Valor	Description
LoadBalancer
NodePort

KubeEnvironment

Objeto

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

Nome	Tipo	Description
extendedLocation	ExtendedLocation	Local Estendido.
id	string	ID do recurso.
kind	string	Tipo de recurso. Se o recurso for um aplicativo, você poderá consultar https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference para obter detalhes de valores com suporte para tipo.
location	string	Local do recurso.
name	string	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, há suporte apenas para "log-analytics"
properties.arcConfiguration	ArcConfiguration	Configuração de cluster que determina os tipos de componentes do cluster ARC. Por exemplo: escolhendo entre o tipo BuildService, o ArtifactsStorageType do Serviço front-end 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 da VNET
properties.defaultDomain	string	Nome de Domínio Padrão para o cluster
properties.deploymentErrors	string	Todos os erros que ocorreram durante a implantação ou validação de implantação
properties.environmentType	string	Tipo de Ambiente do Kubernetes. Com suporte apenas para ambientes de aplicativo de contêiner com valor como Gerenciado
properties.internalLoadBalancerEnabled	boolean	Somente visível dentro da Vnet/Sub-rede
properties.provisioningState	KubeEnvironmentProvisioningState	Estado de provisionamento do Ambiente do Kubernetes.
properties.staticIp	string	IP estático do KubeEnvironment
tags	object	Tags de recursos.
type	string	Tipo de recurso.

KubeEnvironmentProvisioningState

Enumeração

Estado de provisionamento do Ambiente do Kubernetes.

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

LogAnalyticsConfiguration

Objeto

Nome	Tipo	Description
customerId	string
sharedKey	string

StorageType

Enumeração

Valor	Description
LocalNode
NetworkFileSystem

Compartilhar via

Kube Environments - Create Or Update

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

azure_auth

Escopos

Exemplos

Create kube environments

Solicitação de exemplo

Resposta de exemplo

Definições

AppLogsConfiguration

ArcConfiguration

ContainerAppsConfiguration

DefaultErrorResponse

Details

Error

ExtendedLocation

FrontEndConfiguration

FrontEndServiceType

KubeEnvironment

KubeEnvironmentProvisioningState

LogAnalyticsConfiguration

StorageType