Kube Environments - Get

Service:

App Service

API-versie:

2024-04-01

Beschrijving voor het ophalen van de eigenschappen van een Kubernetes-omgeving.

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

URI-parameters

Name	In	Vereist	Type	Description
name	path	True	string	Naam van de Kubernetes-omgeving.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Naam van de resourcegroep waartoe de resource behoort.
subscriptionId	path	True	string	Uw Azure-abonnements-id. Dit is een tekenreeks met GUID-indeling (bijvoorbeeld 00000000-0000-0000-0000-000000000000000).
api-version	query	True	string	API-versie

Antwoorden

Name	Type	Description
200 OK	KubeEnvironment	OK
Other Status Codes	DefaultErrorResponse	Foutreactie van App Service.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

Get kube environments by name

Voorbeeldaanvraag

HTTP

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

Java

/**
 * Samples for KubeEnvironments GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2024-04-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

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_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/2024-04-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

Go

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/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_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

JavaScript

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

/**
 * 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/2024-04-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

dotnet

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

Voorbeeldrespons

Statuscode:

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

Definities

Name	Description
AppLogsConfiguration
ArcConfiguration
ContainerAppsConfiguration
DefaultErrorResponse	Foutreactie van App Service.
Details
Error	Foutmodel.
ExtendedLocation	Uitgebreide locatie.
FrontEndConfiguration
FrontEndServiceType
KubeEnvironment	Een Kubernetes-cluster dat is gespecialiseerd voor webworkloads door Azure App Service
KubeEnvironmentProvisioningState	Inrichtingsstatus van de Kubernetes-omgeving.
LogAnalyticsConfiguration
StorageType

AppLogsConfiguration

Object

Name	Type	Description
destination	string
logAnalyticsConfiguration	LogAnalyticsConfiguration

ArcConfiguration

Object

Name	Type	Description
artifactStorageAccessMode	string
artifactStorageClassName	string
artifactStorageMountPath	string
artifactStorageNodeName	string
artifactsStorageType	StorageType
frontEndServiceConfiguration	FrontEndConfiguration
kubeConfig	string

ContainerAppsConfiguration

Object

Name	Type	Description
appSubnetResourceId	string	Resource-id van een subnet voor onderdelen van de besturingsvlakinfrastructuur. Dit subnet moet zich in hetzelfde VNET bevinden als het subnet dat is gedefinieerd in appSubnetResourceId. Mag niet overlappen met het IP-bereik dat is gedefinieerd in platformReservedCidr, indien gedefinieerd.
controlPlaneSubnetResourceId	string	Resource-id van een subnet voor onderdelen van de besturingsvlakinfrastructuur. Dit subnet moet zich in hetzelfde VNET bevinden als het subnet dat is gedefinieerd in appSubnetResourceId. Mag niet overlappen met het IP-bereik dat is gedefinieerd in platformReservedCidr, indien gedefinieerd.
daprAIInstrumentationKey	string	Azure Monitor-instrumentatiesleutel die door Dapr wordt gebruikt voor het exporteren van telemetrie van service-naar-service-communicatie
dockerBridgeCidr	string	CIDR-notatie-IP-bereik dat is toegewezen aan het Docker-brugnetwerk. Het mag niet overlappen met subnet-IP-bereiken of het IP-bereik dat is gedefinieerd in platformReservedCidr, indien gedefinieerd.
platformReservedCidr	string	IP-bereik in CIDR-notatie die kan worden gereserveerd voor IP-adressen van de omgevingsinfrastructuur. Deze mag niet overlappen met andere IP-adresbereiken van het subnet.
platformReservedDnsIP	string	Een IP-adres uit het IP-bereik dat is gedefinieerd door platformReservedCidr die wordt gereserveerd voor de interne DNS-server

DefaultErrorResponse

Object

Foutreactie van App Service.

Name	Type	Description
error	Error	Foutmodel.

Details

Object

Name	Type	Description
code	string	Gestandaardiseerde tekenreeks om de fout programmatisch te identificeren.
message	string	Gedetailleerde foutbeschrijving en foutopsporingsgegevens.
target	string	Gedetailleerde foutbeschrijving en foutopsporingsgegevens.

Error

Object

Foutmodel.

Name	Type	Description
code	string	Gestandaardiseerde tekenreeks om de fout programmatisch te identificeren.
details	Details[]	Gedetailleerde fouten.
innererror	string	Meer informatie over foutopsporing.
message	string	Gedetailleerde foutbeschrijving en foutopsporingsgegevens.
target	string	Gedetailleerde foutbeschrijving en foutopsporingsgegevens.

ExtendedLocation

Object

Uitgebreide locatie.

Name	Type	Description
name	string	Naam van uitgebreide locatie.
type	string	Type uitgebreide locatie.

FrontEndConfiguration

Object

Name	Type	Description
kind	FrontEndServiceType

FrontEndServiceType

Inventarisatie

Waarde	Description
LoadBalancer
NodePort

KubeEnvironment

Object

Een Kubernetes-cluster dat is gespecialiseerd voor webworkloads door Azure App Service

Name	Type	Description
extendedLocation	ExtendedLocation	Uitgebreide locatie.
id	string	Resource-id.
kind	string	Soort resource. Als de resource een app is, kunt u verwijzen naar https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference voor meer informatie over ondersteunde waarden voor soort.
location	string	Resourcelocatie.
name	string	Resourcenaam.
properties.aksResourceID	string
properties.appLogsConfiguration	AppLogsConfiguration	Clusterconfiguratie waarmee de logboekdemon app-logboeken naar een bestemming kan exporteren. Momenteel wordt alleen 'log-analytics' ondersteund
properties.arcConfiguration	ArcConfiguration	Clusterconfiguratie waarmee de typen ARC-clusteronderdelen worden bepaald. Bijvoorbeeld: Kiezen tussen BuildService-soort, FrontEnd Service ArtifactsStorageType, enzovoort.
properties.containerAppsConfiguration	ContainerAppsConfiguration	Clusterconfiguratie voor Container Apps-omgevingen voor het configureren van de Dapr Instrumentation-sleutel en VNET-configuratie
properties.defaultDomain	string	Standaarddomeinnaam voor het cluster
properties.deploymentErrors	string	Eventuele fouten die zijn opgetreden tijdens de implementatie of implementatievalidatie
properties.environmentType	string	Type Kubernetes-omgeving. Alleen ondersteund voor container-app-omgevingen met waarde als beheerd
properties.internalLoadBalancerEnabled	boolean	Alleen zichtbaar in Vnet/Subnet
properties.provisioningState	KubeEnvironmentProvisioningState	Inrichtingsstatus van de Kubernetes-omgeving.
properties.staticIp	string	Statisch IP-adres van kubeEnvironment
tags	object	Resourcetags.
type	string	Resourcetype.

KubeEnvironmentProvisioningState

Inventarisatie

Inrichtingsstatus van de Kubernetes-omgeving.

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

LogAnalyticsConfiguration

Object

Name	Type	Description
customerId	string
sharedKey	string

StorageType

Inventarisatie

Waarde	Description
LocalNode
NetworkFileSystem