swagger: '2.0' info: version: '2023-01-01' title: Microsoft Azure KubeEnvironments API Client host: management.azure.com schemes: - https consumes: - application/json produces: - application/json paths: /subscriptions/{subscriptionId}/providers/Microsoft.Web/kubeEnvironments: get: tags: - KubeEnvironments summary: 'Microsoft Azure Get All Kubernetes Environments For A Subscription' description: Description for Get all Kubernetes Environments for a subscription. operationId: microsoftAzureKubeenvironmentsListbysubscription parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/KubeEnvironmentCollection' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: List kube environments by subscription: $ref: ./examples/KubeEnvironments_ListBySubscription.json /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/kubeEnvironments: get: tags: - KubeEnvironments summary: 'Microsoft Azure Get All The Kubernetes Environments In A Resource Group' description: Description for Get all the Kubernetes Environments in a resource group. operationId: microsoftAzureKubeenvironmentsListbyresourcegroup parameters: - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/KubeEnvironmentCollection' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: List kube environments by resource group: $ref: ./examples/KubeEnvironments_ListByResourceGroup.json /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/kubeEnvironments/{name}: get: tags: - KubeEnvironments summary: 'Microsoft Azure Get The Properties Of A Kubernetes Environment' description: Description for Get the properties of a Kubernetes Environment. operationId: microsoftAzureKubeenvironmentsGet parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the Kubernetes Environment. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/KubeEnvironment' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Get kube environments by name: $ref: ./examples/KubeEnvironments_Get.json put: tags: - KubeEnvironments summary: 'Microsoft Azure Creates Or Updates A Kubernetes Environment' description: Description for Creates or updates a Kubernetes Environment. operationId: microsoftAzureKubeenvironmentsCreateorupdate parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the Kubernetes Environment. required: true type: string - name: kubeEnvironmentEnvelope in: body description: Configuration details of the Kubernetes Environment. required: true schema: $ref: '#/definitions/KubeEnvironment' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/KubeEnvironment' '201': description: Created schema: $ref: '#/definitions/KubeEnvironment' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-long-running-operation: true x-ms-examples: Create kube environments: $ref: ./examples/KubeEnvironments_CreateOrUpdate.json delete: tags: - KubeEnvironments summary: 'Microsoft Azure Delete A Kubernetes Environment' description: Description for Delete a Kubernetes Environment. operationId: microsoftAzureKubeenvironmentsDelete parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the Kubernetes Environment. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Delete operation completed '202': description: Delete operation is in progress '204': description: Kubernetes Environment does not exist default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Delete kube environment by name: $ref: ./examples/KubeEnvironments_Delete.json x-ms-long-running-operation: true patch: tags: - KubeEnvironments summary: 'Microsoft Azure Creates Or Updates A Kubernetes Environment' description: Description for Creates or updates a Kubernetes Environment. operationId: microsoftAzureKubeenvironmentsUpdate parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the Kubernetes Environment. required: true type: string - name: kubeEnvironmentEnvelope in: body description: Configuration details of the Kubernetes Environment. required: true schema: $ref: '#/definitions/KubeEnvironmentPatchResource' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/KubeEnvironment' '201': description: Created schema: $ref: '#/definitions/KubeEnvironment' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Update kube environments: $ref: ./examples/KubeEnvironments_Update.json definitions: AppLogsConfiguration: type: object properties: destination: type: string logAnalyticsConfiguration: $ref: '#/definitions/LogAnalyticsConfiguration' ContainerAppsConfiguration: type: object properties: daprAIInstrumentationKey: type: string description: >- Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry x-ms-mutability: - create - read platformReservedCidr: type: string description: >- IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. It must not overlap with any other Subnet IP ranges. x-ms-mutability: - create - read platformReservedDnsIP: type: string description: >- An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server x-ms-mutability: - create - read controlPlaneSubnetResourceId: type: string description: >- Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined. x-ms-mutability: - create - read appSubnetResourceId: type: string description: >- Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined. x-ms-mutability: - create - read dockerBridgeCidr: type: string description: >- CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the IP range defined in platformReservedCidr, if defined. x-ms-mutability: - create - read ArcConfiguration: type: object properties: artifactsStorageType: enum: - LocalNode - NetworkFileSystem type: string x-ms-enum: name: StorageType modelAsString: false x-ms-mutability: - create - read artifactStorageClassName: type: string x-ms-mutability: - create - read artifactStorageMountPath: type: string x-ms-mutability: - create - read artifactStorageNodeName: type: string x-ms-mutability: - create - read artifactStorageAccessMode: type: string x-ms-mutability: - create - read frontEndServiceConfiguration: $ref: '#/definitions/FrontEndConfiguration' kubeConfig: type: string x-ms-mutability: - create - update x-ms-secret: true FrontEndConfiguration: type: object properties: kind: enum: - NodePort - LoadBalancer type: string x-ms-enum: name: FrontEndServiceType modelAsString: false KubeEnvironment: description: A Kubernetes cluster specialized for web workloads by Azure App Service type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/Resource properties: properties: description: KubeEnvironment resource specific properties type: object properties: provisioningState: description: Provisioning state of the Kubernetes Environment. enum: - Succeeded - Failed - Canceled - Waiting - InitializationInProgress - InfrastructureSetupInProgress - InfrastructureSetupComplete - ScheduledForDelete - UpgradeRequested - UpgradeFailed type: string readOnly: true x-ms-enum: name: KubeEnvironmentProvisioningState modelAsString: false deploymentErrors: description: >- Any errors that occurred during deployment or deployment validation type: string readOnly: true internalLoadBalancerEnabled: description: Only visible within Vnet/Subnet type: boolean x-ms-mutability: - create - read defaultDomain: description: Default Domain Name for the cluster type: string readOnly: true staticIp: description: Static IP of the KubeEnvironment type: string x-ms-mutability: - create - read environmentType: description: >- Type of Kubernetes Environment. Only supported for Container App Environments with value as Managed type: string x-ms-mutability: - create - read arcConfiguration: $ref: '#/definitions/ArcConfiguration' description: |- Cluster configuration which determines the ARC cluster components types. Eg: Choosing between BuildService kind, FrontEnd Service ArtifactsStorageType etc. appLogsConfiguration: $ref: '#/definitions/AppLogsConfiguration' description: |- Cluster configuration which enables the log daemon to export app logs to a destination. Currently only "log-analytics" is supported containerAppsConfiguration: $ref: '#/definitions/ContainerAppsConfiguration' description: >- Cluster configuration for Container Apps Environments to configure Dapr Instrumentation Key and VNET Configuration aksResourceID: type: string x-ms-mutability: - create - read x-ms-client-flatten: true extendedLocation: $ref: ./CommonDefinitions.json#/definitions/ExtendedLocation KubeEnvironmentCollection: description: Collection of Kubernetes Environments required: - value type: object properties: value: description: Collection of resources. type: array items: $ref: '#/definitions/KubeEnvironment' nextLink: description: Link to next page of resources. type: string readOnly: true KubeEnvironmentPatchResource: description: ARM resource for a KubeEnvironment when patching type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: KubeEnvironmentPatchResource resource specific properties type: object properties: provisioningState: description: Provisioning state of the Kubernetes Environment. enum: - Succeeded - Failed - Canceled - Waiting - InitializationInProgress - InfrastructureSetupInProgress - InfrastructureSetupComplete - ScheduledForDelete - UpgradeRequested - UpgradeFailed type: string readOnly: true x-ms-enum: name: KubeEnvironmentProvisioningState modelAsString: false deploymentErrors: description: >- Any errors that occurred during deployment or deployment validation type: string readOnly: true internalLoadBalancerEnabled: description: Only visible within Vnet/Subnet type: boolean x-ms-mutability: - create - read defaultDomain: description: Default Domain Name for the cluster type: string readOnly: true staticIp: description: Static IP of the KubeEnvironment type: string x-ms-mutability: - create - read arcConfiguration: $ref: '#/definitions/ArcConfiguration' description: |- Cluster configuration which determines the ARC cluster components types. Eg: Choosing between BuildService kind, FrontEnd Service ArtifactsStorageType etc. appLogsConfiguration: $ref: '#/definitions/AppLogsConfiguration' description: |- Cluster configuration which enables the log daemon to export app logs to a destination. Currently only "log-analytics" is supported containerAppsConfiguration: $ref: '#/definitions/ContainerAppsConfiguration' description: >- Cluster configuration for Container Apps Environments to configure Dapr Instrumentation Key and VNET Configuration aksResourceID: type: string x-ms-mutability: - create - read x-ms-client-flatten: true LogAnalyticsConfiguration: type: object properties: customerId: type: string sharedKey: type: string x-ms-mutability: - create - update x-ms-secret: true parameters: subscriptionIdParameter: name: subscriptionId in: path description: >- Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). required: true type: string x-ms-parameter-location: client resourceGroupNameParameter: name: resourceGroupName in: path description: Name of the resource group to which the resource belongs. required: true type: string maxLength: 90 minLength: 1 pattern: ^[-\w\._\(\)]+[^\.]$ x-ms-parameter-location: method apiVersionParameter: name: api-version in: query description: API Version required: true type: string x-ms-parameter-location: client securityDefinitions: azure_auth: type: oauth2 description: Azure Active Directory OAuth2 Flow flow: implicit authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize scopes: user_impersonation: impersonate your user account security: - azure_auth: - user_impersonation tags: - name: KubeEnvironments