Kube Environments - Create Or Update

Szolgáltatás:

App Service

API-verzió:

2024-04-01

Kubernetes-környezet létrehozása vagy frissítése.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
name	path	True	string	A Kubernetes-környezet neve.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Annak az erőforráscsoportnak a neve, amelyhez az erőforrás tartozik.
subscriptionId	path	True	string	Az Azure-előfizetés azonosítója. Ez egy GUID formátumú sztring (például 000000000-0000-0000-0000-0000000000).
api-version	query	True	string	API-verzió

Kérelem törzse

Name	Kötelező	Típus	Description
location	True	string	Erőforrás helye.
extendedLocation		ExtendedLocation	Kiterjesztett hely.
kind		string	Erőforrás típusa. Ha az erőforrás egy alkalmazás, a https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference a természetben támogatott értékek részleteiért tekintse meg.
properties.aksResourceID		string
properties.appLogsConfiguration		AppLogsConfiguration	Fürtkonfiguráció, amely lehetővé teszi, hogy a naplódémon alkalmazásnaplókat exportáljon egy célhelyre. Jelenleg csak a "log-analytics" támogatott
properties.arcConfiguration		ArcConfiguration	Az ARC-fürt összetevőinek típusait meghatározó fürtkonfiguráció. Például: Választás a BuildService típusa, a FrontEnd Service ArtifactsStorageType stb. között.
properties.containerAppsConfiguration		ContainerAppsConfiguration	A Container Apps-környezetek fürtkonfigurációja a Dapr Instrumentation Key és a VNET konfigurációjának konfigurálásához
properties.environmentType		string	A Kubernetes-környezet típusa. Csak felügyelt értékekkel rendelkező Tárolóalkalmazás-környezetek esetén támogatott
properties.internalLoadBalancerEnabled		boolean	Csak a virtuális hálózaton/alhálózaton belül látható
properties.staticIp		string	A KubeEnvironment statikus IP-címe
tags		object	Erőforráscímkék.

Válaszok

Name	Típus	Description
200 OK	KubeEnvironment	OKÉ
201 Created	KubeEnvironment	Létrehozott
Other Status Codes	DefaultErrorResponse	App Service-hibaválasz.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

Create kube environments

Mintakérelem

HTTP

PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.Web/kubeEnvironments/testkubeenv?api-version=2024-04-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:
     * specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/KubeEnvironments_CreateOrUpdate.json
     */
    /**
     * Sample code: Create kube environments.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createKubeEnvironments(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.web import WebSiteManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-web
# USAGE
    python kube_environments_create_or_update.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = WebSiteManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
    )

    response = client.kube_environments.begin_create_or_update(
        resource_group_name="examplerg",
        name="testkubeenv",
        kube_environment_envelope={"location": "East US", "properties": {"staticIp": "1.2.3.4"}},
    ).result()
    print(response)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/KubeEnvironments_CreateOrUpdate.json
if __name__ == "__main__":
    main()

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/v4"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b5d78da207e9c5d8f82e95224039867271f47cdf/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/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("<subscription-id>", 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.KubeEnvironment = armappservice.KubeEnvironment{
	// 	Name: to.Ptr("testkubeenv"),
	// 	Type: to.Ptr("Microsoft.Web/kubeEnvironments"),
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.Web/kubeEnvironments/testkubeenv"),
	// 	Location: to.Ptr("East US"),
	// 	Tags: map[string]*string{
	// 	},
	// 	ExtendedLocation: &armappservice.ExtendedLocation{
	// 		Name: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation"),
	// 		Type: to.Ptr("customLocation"),
	// 	},
	// 	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"),
	// 	},
	// }
}

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

JavaScript

const { WebSiteManagementClient } = require("@azure/arm-appservice");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Description for Creates or updates a Kubernetes Environment.
 *
 * @summary Description for Creates or updates a Kubernetes Environment.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/KubeEnvironments_CreateOrUpdate.json
 */
async function createKubeEnvironments() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "examplerg";
  const name = "testkubeenv";
  const kubeEnvironmentEnvelope = {
    location: "East US",
    staticIp: "1.2.3.4",
  };
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.kubeEnvironments.beginCreateOrUpdateAndWait(
    resourceGroupName,
    name,
    kubeEnvironmentEnvelope,
  );
  console.log(result);
}

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

dotnet

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-04-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

Mintaválasz

Állapotkód:

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"
  }
}

Állapotkód:

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"
  }
}

Definíciók

Name	Description
AppLogsConfiguration
ArcConfiguration
ContainerAppsConfiguration
DefaultErrorResponse	App Service-hibaválasz.
Details
Error	Hibamodell.
ExtendedLocation	Kiterjesztett hely.
FrontEndConfiguration
FrontEndServiceType
KubeEnvironment	Az Azure App Service által a webes számítási feladatokra specializált Kubernetes-fürt
KubeEnvironmentProvisioningState	A Kubernetes-környezet kiépítési állapota.
LogAnalyticsConfiguration
StorageType

AppLogsConfiguration

Objektum

Name	Típus	Description
destination	string
logAnalyticsConfiguration	LogAnalyticsConfiguration

ArcConfiguration

Objektum

Name	Típus	Description
artifactStorageAccessMode	string
artifactStorageClassName	string
artifactStorageMountPath	string
artifactStorageNodeName	string
artifactsStorageType	StorageType
frontEndServiceConfiguration	FrontEndConfiguration
kubeConfig	string

ContainerAppsConfiguration

Objektum

Name	Típus	Description
appSubnetResourceId	string	A vezérlősík-infrastruktúra összetevőinek alhálózatának erőforrás-azonosítója. Ennek az alhálózatnak ugyanabban a virtuális hálózaton kell lennie, mint az appSubnetResourceId fájlban definiált alhálózatnak. Ha meg van adva, nem lehet átfedésben a platformReservedCidrben definiált IP-tartománnyal.
controlPlaneSubnetResourceId	string	A vezérlősík-infrastruktúra összetevőinek alhálózatának erőforrás-azonosítója. Ennek az alhálózatnak ugyanabban a virtuális hálózaton kell lennie, mint az appSubnetResourceId fájlban definiált alhálózatnak. Ha meg van adva, nem lehet átfedésben a platformReservedCidrben definiált IP-tartománnyal.
daprAIInstrumentationKey	string	A Dapr által a Szolgáltatás szolgáltatásba irányuló kommunikációs telemetriai adatok exportálásához használt Azure Monitor-rendszerállapot-kulcs
dockerBridgeCidr	string	A Docker-híd hálózatához rendelt CIDR-jelölési IP-tartomány. Nem fedheti át az alhálózati IP-tartományokat vagy a platformReservedCidrben definiált IP-tartományt, ha meg van adva.
platformReservedCidr	string	A CIDR-jelölés ip-tartománya, amely a környezeti infrastruktúra IP-címeinek fenntartotta. Nem lehet átfedésben más alhálózati IP-tartományokkal.
platformReservedDnsIP	string	A platformReservedCidr által meghatározott IP-cím, amely a belső DNS-kiszolgáló számára lesz fenntartva

DefaultErrorResponse

Objektum

App Service-hibaválasz.

Name	Típus	Description
error	Error	Hibamodell.

Details

Objektum

Name	Típus	Description
code	string	Szabványosított sztring a hiba programozott azonosításához.
message	string	Részletes hibaleírás és hibakeresési információk.
target	string	Részletes hibaleírás és hibakeresési információk.

Error

Objektum

Hibamodell.

Name	Típus	Description
code	string	Szabványosított sztring a hiba programozott azonosításához.
details	Details[]	Részletes hibák.
innererror	string	További információ a hibakereséshez.
message	string	Részletes hibaleírás és hibakeresési információk.
target	string	Részletes hibaleírás és hibakeresési információk.

ExtendedLocation

Objektum

Kiterjesztett hely.

Name	Típus	Description
name	string	A kiterjesztett hely neve.
type	string	A kiterjesztett hely típusa.

FrontEndConfiguration

Objektum

Name	Típus	Description
kind	FrontEndServiceType

FrontEndServiceType

Enumerálás

Érték	Description
LoadBalancer
NodePort

KubeEnvironment

Objektum

Az Azure App Service által a webes számítási feladatokra specializált Kubernetes-fürt

Name	Típus	Description
extendedLocation	ExtendedLocation	Kiterjesztett hely.
id	string	Erőforrás-azonosító.
kind	string	Erőforrás típusa. Ha az erőforrás egy alkalmazás, a https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference a természetben támogatott értékek részleteiért tekintse meg.
location	string	Erőforrás helye.
name	string	Erőforrás neve.
properties.aksResourceID	string
properties.appLogsConfiguration	AppLogsConfiguration	Fürtkonfiguráció, amely lehetővé teszi, hogy a naplódémon alkalmazásnaplókat exportáljon egy célhelyre. Jelenleg csak a "log-analytics" támogatott
properties.arcConfiguration	ArcConfiguration	Az ARC-fürt összetevőinek típusait meghatározó fürtkonfiguráció. Például: Választás a BuildService típusa, a FrontEnd Service ArtifactsStorageType stb. között.
properties.containerAppsConfiguration	ContainerAppsConfiguration	A Container Apps-környezetek fürtkonfigurációja a Dapr Instrumentation Key és a VNET konfigurációjának konfigurálásához
properties.defaultDomain	string	A fürt alapértelmezett tartományneve
properties.deploymentErrors	string	Az üzembe helyezés vagy az üzembe helyezés ellenőrzése során előforduló hibák
properties.environmentType	string	A Kubernetes-környezet típusa. Csak felügyelt értékekkel rendelkező Tárolóalkalmazás-környezetek esetén támogatott
properties.internalLoadBalancerEnabled	boolean	Csak a virtuális hálózaton/alhálózaton belül látható
properties.provisioningState	KubeEnvironmentProvisioningState	A Kubernetes-környezet kiépítési állapota.
properties.staticIp	string	A KubeEnvironment statikus IP-címe
tags	object	Erőforráscímkék.
type	string	Erőforrás típusa.

KubeEnvironmentProvisioningState

Enumerálás

A Kubernetes-környezet kiépítési állapota.

Érték	Description
Canceled
Failed
InfrastructureSetupComplete
InfrastructureSetupInProgress
InitializationInProgress
ScheduledForDelete
Succeeded
UpgradeFailed
UpgradeRequested
Waiting

LogAnalyticsConfiguration

Objektum

Name	Típus	Description
customerId	string
sharedKey	string

StorageType

Enumerálás

Érték	Description
LocalNode
NetworkFileSystem