Kube Environments - Get

Referencia

Szolgáltatás:: App Service

API-verzió:: 2023-12-01

Leírás a Kubernetes-környezet tulajdonságainak lekéréséhez.

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

URI-paraméterek

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

Válaszok

Name	Típus	Description
200 OK	KubeEnvironment	OK
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	felhasználói fiók megszemélyesítése

Példák

Get kube environments by name

Mintakérelem

GET https://management.azure.com/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.Web/kubeEnvironments/jlaw-demo1?api-version=2023-12-01


/**
 * Samples for KubeEnvironments GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/KubeEnvironments_Get.json
     */
    /**
     * Sample code: Get kube environments by name.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getKubeEnvironmentsByName(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getKubeEnvironments().getByResourceGroupWithResponse("examplerg",
            "jlaw-demo1", 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

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_get.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="8efdecc5-919e-44eb-b179-915dca89ebf9",
    )

    response = client.kube_environments.get(
        resource_group_name="examplerg",
        name="jlaw-demo1",
    )
    print(response)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/KubeEnvironments_Get.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

package armappservice_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/de1f3772629b6f4d3ac01548a5f6d719bfb97c9e/specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/KubeEnvironments_Get.json
func ExampleKubeEnvironmentsClient_Get() {
	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)
	}
	res, err := clientFactory.NewKubeEnvironmentsClient().Get(ctx, "examplerg", "jlaw-demo1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %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("jlaw-demo1"),
	// 	Type: to.Ptr("Microsoft.Web/kubeEnvironments"),
	// 	ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.Web/kubeEnvironments/jlaw-demo1"),
	// 	Location: to.Ptr("North Central US"),
	// 	Tags: map[string]*string{
	// 	},
	// 	ExtendedLocation: &armappservice.ExtendedLocation{
	// 		Name: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation"),
	// 		Type: to.Ptr("customLocation"),
	// 	},
	// 	Properties: &armappservice.KubeEnvironmentProperties{
	// 		AksResourceID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.ContainerService/managedClusters/jlaw-demo1"),
	// 		DefaultDomain: to.Ptr("jlaw-demo1.k4apps.io"),
	// 		InternalLoadBalancerEnabled: to.Ptr(false),
	// 		ProvisioningState: to.Ptr(armappservice.KubeEnvironmentProvisioningStateSucceeded),
	// 		StaticIP: to.Ptr("20.42.33.145"),
	// 	},
	// }
}

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

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

/**
 * This sample demonstrates how to Description for Get the properties of a Kubernetes Environment.
 *
 * @summary Description for Get the properties of a Kubernetes Environment.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/KubeEnvironments_Get.json
 */
async function getKubeEnvironmentsByName() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "8efdecc5-919e-44eb-b179-915dca89ebf9";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "examplerg";
  const name = "jlaw-demo1";
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.kubeEnvironments.get(resourceGroupName, name);
  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

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

// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/KubeEnvironments_Get.json
// this example is just showing the usage of "KubeEnvironments_Get" 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 KubeEnvironmentResource created on azure
// for more information of creating KubeEnvironmentResource, please refer to the document of KubeEnvironmentResource
string subscriptionId = "8efdecc5-919e-44eb-b179-915dca89ebf9";
string resourceGroupName = "examplerg";
string name = "jlaw-demo1";
ResourceIdentifier kubeEnvironmentResourceId = KubeEnvironmentResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name);
KubeEnvironmentResource kubeEnvironment = client.GetKubeEnvironmentResource(kubeEnvironmentResourceId);

// invoke the operation
KubeEnvironmentResource result = await kubeEnvironment.GetAsync();

// 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/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.Web/kubeEnvironments/jlaw-demo1",
  "name": "jlaw-demo1",
  "type": "Microsoft.Web/kubeEnvironments",
  "location": "North Central US",
  "extendedLocation": {
    "name": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation",
    "type": "customLocation"
  },
  "tags": {},
  "properties": {
    "provisioningState": "Succeeded",
    "deploymentErrors": null,
    "internalLoadBalancerEnabled": false,
    "defaultDomain": "jlaw-demo1.k4apps.io",
    "staticIp": "20.42.33.145",
    "arcConfiguration": null,
    "appLogsConfiguration": null,
    "aksResourceID": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.ContainerService/managedClusters/jlaw-demo1"
  }
}

Definíciók

Name	Description
AppLogsConfiguration
ArcConfiguration
ContainerAppsConfiguration
DefaultErrorResponse	App Service hibaválasz.
Details
Error	Hibamodell.
ExtendedLocation	Bővített hely.
FrontEndConfiguration
FrontEndServiceType
KubeEnvironment	Webes számítási feladatokra szakosodott Kubernetes-fürt Azure App Service
KubeEnvironmentProvisioningState	A Kubernetes-környezet kiépítési állapota.
LogAnalyticsConfiguration
StorageType

AppLogsConfiguration

Name	Típus	Description
destination	string
logAnalyticsConfiguration	LogAnalyticsConfiguration

ArcConfiguration

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

ContainerAppsConfiguration

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ózatban kell lennie, mint az appSubnetResourceIdban definiált alhálózatnak. Ha meg van adva, nem lehet átfedésben a platformReservedCidrben definiált IP-címtartománysal.
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ózatban kell lennie, mint az appSubnetResourceIdban definiált alhálózatnak. Ha meg van adva, nem lehet átfedésben a platformReservedCidrben definiált IP-címtartománysal.
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állapotkulcs
dockerBridgeCidr	string	A Docker-híd hálózatához rendelt CIDR-jelölési IP-címtartomá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ésben szereplő IP-címtartomány, amely fenntartható a környezeti infrastruktúra IP-címeinek számára. Nem lehet átfedésben más alhálózati IP-címtartományokkal.
platformReservedDnsIP	string	A platformReservedCidr által meghatározott IP-címtartományból származó IP-cím, amely a belső DNS-kiszolgáló számára lesz fenntartva

DefaultErrorResponse

App Service hibaválasz.

Name	Típus	Description
error	Error	Hibamodell.

Details

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

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

Bővített hely.

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

FrontEndConfiguration

Name	Típus	Description
kind	FrontEndServiceType

FrontEndServiceType

Name	Típus	Description
LoadBalancer	string
NodePort	string

KubeEnvironment

Webes számítási feladatokra szakosodott Kubernetes-fürt Azure App Service

Name	Típus	Description
extendedLocation	ExtendedLocation	Bővített hely.
id	string	Erőforrás-azonosító.
kind	string	Erőforrás típusa.
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ők 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 Tárolóalkalmazás-környezetek fürtkonfigurációja a Dapr Instrumentation Key és a VNET-konfiguráció 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ékkel rendelkező tárolóalkalmazás-környezetek esetében 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ástípus.

KubeEnvironmentProvisioningState

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

Name	Típus	Description
Canceled	string
Failed	string
InfrastructureSetupComplete	string
InfrastructureSetupInProgress	string
InitializationInProgress	string
ScheduledForDelete	string
Succeeded	string
UpgradeFailed	string
UpgradeRequested	string
Waiting	string

LogAnalyticsConfiguration

Name	Típus	Description
customerId	string
sharedKey	string

StorageType

Name	Típus	Description
LocalNode	string
NetworkFileSystem	string