Freigeben über


Kube Environments - Create Or Update

Beschreibung für Erstellt oder aktualisiert eine Kubernetes-Umgebung.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
name
path True

string

Name der Kubernetes-Umgebung.

resourceGroupName
path True

string

Name der Ressourcengruppe, zu der die Ressource gehört.

RegEx-Muster: ^[-\w\._\(\)]+[^\.]$

subscriptionId
path True

string

die Azure-Abonnement-ID Dies ist eine GUID-formatierte Zeichenfolge (z. B. 0000000-0000-0000-0000-00000000000000000).

api-version
query True

string

API-Version

Anforderungstext

Name Erforderlich Typ Beschreibung
location True

string

Ressourcenspeicherort.

extendedLocation

ExtendedLocation

Erweiterter Speicherort.

kind

string

Art der Ressource.

properties.aksResourceID

string

properties.appLogsConfiguration

AppLogsConfiguration

Clusterkonfiguration, die es dem Protokolldaemon ermöglicht, App-Protokolle an ein Ziel zu exportieren. Derzeit wird nur "log-analytics" unterstützt.

properties.arcConfiguration

ArcConfiguration

Clusterkonfiguration, die die Typen der ARC-Clusterkomponenten bestimmt. Beispiel: Auswahl zwischen BuildService-Art, FrontEnd Service ArtifactsStorageType usw.

properties.containerAppsConfiguration

ContainerAppsConfiguration

Clusterkonfiguration für Container Apps-Umgebungen zum Konfigurieren des Dapr-Instrumentierungsschlüssels und der VNET-Konfiguration

properties.environmentType

string

Typ der Kubernetes-Umgebung. Nur für Container-App-Umgebungen mit dem Wert "Managed" unterstützt

properties.internalLoadBalancerEnabled

boolean

Nur innerhalb des VNET/Subnetzes sichtbar

properties.staticIp

string

Statische IP-Adresse der KubeEnvironment

tags

object

Ressourcentags.

Antworten

Name Typ Beschreibung
200 OK

KubeEnvironment

OK

201 Created

KubeEnvironment

Erstellt

Other Status Codes

DefaultErrorResponse

App Service Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

Create kube environments

Beispielanforderung

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

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
AppLogsConfiguration
ArcConfiguration
ContainerAppsConfiguration
DefaultErrorResponse

App Service Fehlerantwort.

Details
Error

Fehlermodell.

ExtendedLocation

Erweiterter Speicherort.

FrontEndConfiguration
FrontEndServiceType
KubeEnvironment

Ein Kubernetes-Cluster, der auf Webworkloads durch Azure App Service spezialisiert ist

KubeEnvironmentProvisioningState

Bereitstellungsstatus der Kubernetes-Umgebung.

LogAnalyticsConfiguration
StorageType

AppLogsConfiguration

Name Typ Beschreibung
destination

string

logAnalyticsConfiguration

LogAnalyticsConfiguration

ArcConfiguration

Name Typ Beschreibung
artifactStorageAccessMode

string

artifactStorageClassName

string

artifactStorageMountPath

string

artifactStorageNodeName

string

artifactsStorageType

StorageType

frontEndServiceConfiguration

FrontEndConfiguration

kubeConfig

string

ContainerAppsConfiguration

Name Typ Beschreibung
appSubnetResourceId

string

Ressourcen-ID eines Subnetzes für Komponenten der Steuerungsebeneninfrastruktur. Dieses Subnetz muss sich im selben VNET wie das subnetz befinden, das in appSubnetResourceId definiert ist. Darf sich nicht mit dem ip-Bereich überschneiden, der in platformReservedCidr definiert ist, sofern definiert.

controlPlaneSubnetResourceId

string

Ressourcen-ID eines Subnetzes für Komponenten der Steuerungsebeneninfrastruktur. Dieses Subnetz muss sich im selben VNET wie das subnetz befinden, das in appSubnetResourceId definiert ist. Darf sich nicht mit dem ip-Bereich überschneiden, der in platformReservedCidr definiert ist, sofern definiert.

daprAIInstrumentationKey

string

Azure Monitor-Instrumentierungsschlüssel, der von Dapr zum Exportieren von Kommunikationstelemetriedaten von Dienst zu Dienst verwendet wird

dockerBridgeCidr

string

DER IP-Bereich der CIDR-Notation, der dem Docker-Bridge-Netzwerk zugewiesen ist. Er darf sich nicht mit Subnetz-IP-Bereichen oder dem in platformReservedCidr definierten IP-Bereich überschneiden, sofern definiert.

platformReservedCidr

string

IP-Bereich in CIDR-Notation, der für IP-Adressen der Umgebungsinfrastruktur reserviert werden kann. Sie darf sich nicht mit anderen Subnet-IP-Bereichen überschneiden.

platformReservedDnsIP

string

Eine IP-Adresse aus dem durch platformReservedCidr definierten IP-Bereich, die für den internen DNS-Server reserviert wird.

DefaultErrorResponse

App Service Fehlerantwort.

Name Typ Beschreibung
error

Error

Fehlermodell.

Details

Name Typ Beschreibung
code

string

Standardisierte Zeichenfolge zum programmgesteuerten Identifizieren des Fehlers.

message

string

Ausführliche Fehlerbeschreibung und Debuginformationen.

target

string

Ausführliche Fehlerbeschreibung und Debuginformationen.

Error

Fehlermodell.

Name Typ Beschreibung
code

string

Standardisierte Zeichenfolge zum programmgesteuerten Identifizieren des Fehlers.

details

Details[]

Detaillierte Fehler.

innererror

string

Weitere Informationen zum Debuggen des Fehlers.

message

string

Ausführliche Fehlerbeschreibung und Debuginformationen.

target

string

Ausführliche Fehlerbeschreibung und Debuginformationen.

ExtendedLocation

Erweiterter Speicherort.

Name Typ Beschreibung
name

string

Name des erweiterten Speicherorts.

type

string

Typ des erweiterten Standorts.

FrontEndConfiguration

Name Typ Beschreibung
kind

FrontEndServiceType

FrontEndServiceType

Name Typ Beschreibung
LoadBalancer

string

NodePort

string

KubeEnvironment

Ein Kubernetes-Cluster, der auf Webworkloads durch Azure App Service spezialisiert ist

Name Typ Beschreibung
extendedLocation

ExtendedLocation

Erweiterter Speicherort.

id

string

Ressourcen-ID.

kind

string

Art der Ressource.

location

string

Ressourcenspeicherort.

name

string

Ressourcenname.

properties.aksResourceID

string

properties.appLogsConfiguration

AppLogsConfiguration

Clusterkonfiguration, die es dem Protokolldaemon ermöglicht, App-Protokolle an ein Ziel zu exportieren. Derzeit wird nur "log-analytics" unterstützt.

properties.arcConfiguration

ArcConfiguration

Clusterkonfiguration, die die Typen der ARC-Clusterkomponenten bestimmt. Beispiel: Auswahl zwischen BuildService-Art, FrontEnd Service ArtifactsStorageType usw.

properties.containerAppsConfiguration

ContainerAppsConfiguration

Clusterkonfiguration für Container Apps-Umgebungen zum Konfigurieren des Dapr-Instrumentierungsschlüssels und der VNET-Konfiguration

properties.defaultDomain

string

Standarddomänenname für den Cluster

properties.deploymentErrors

string

Alle Fehler, die während der Bereitstellungs- oder Bereitstellungsüberprüfung aufgetreten sind

properties.environmentType

string

Typ der Kubernetes-Umgebung. Nur für Container-App-Umgebungen mit dem Wert "Managed" unterstützt

properties.internalLoadBalancerEnabled

boolean

Nur innerhalb des VNET/Subnetzes sichtbar

properties.provisioningState

KubeEnvironmentProvisioningState

Bereitstellungsstatus der Kubernetes-Umgebung.

properties.staticIp

string

Statische IP-Adresse der KubeEnvironment

tags

object

Ressourcentags.

type

string

Der Ressourcentyp.

KubeEnvironmentProvisioningState

Bereitstellungsstatus der Kubernetes-Umgebung.

Name Typ Beschreibung
Canceled

string

Failed

string

InfrastructureSetupComplete

string

InfrastructureSetupInProgress

string

InitializationInProgress

string

ScheduledForDelete

string

Succeeded

string

UpgradeFailed

string

UpgradeRequested

string

Waiting

string

LogAnalyticsConfiguration

Name Typ Beschreibung
customerId

string

sharedKey

string

StorageType

Name Typ Beschreibung
LocalNode

string

NetworkFileSystem

string