com.azure.resourcemanager.appcontainers.models.ConnectedEnvironment Maven / Gradle / Ivy
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// Code generated by Microsoft (R) AutoRest Code Generator.
package com.azure.resourcemanager.appcontainers.models;
import com.azure.core.http.rest.Response;
import com.azure.core.management.Region;
import com.azure.core.management.SystemData;
import com.azure.core.util.Context;
import com.azure.resourcemanager.appcontainers.fluent.models.ConnectedEnvironmentInner;
import java.util.Map;
/**
* An immutable client-side representation of ConnectedEnvironment.
*/
public interface ConnectedEnvironment {
/**
* Gets the id property: Fully qualified resource Id for the resource.
*
* @return the id value.
*/
String id();
/**
* Gets the name property: The name of the resource.
*
* @return the name value.
*/
String name();
/**
* Gets the type property: The type of the resource.
*
* @return the type value.
*/
String type();
/**
* Gets the location property: The geo-location where the resource lives.
*
* @return the location value.
*/
String location();
/**
* Gets the tags property: Resource tags.
*
* @return the tags value.
*/
Map tags();
/**
* Gets the extendedLocation property: The complex type of the extended location.
*
* @return the extendedLocation value.
*/
ExtendedLocation extendedLocation();
/**
* Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
*
* @return the systemData value.
*/
SystemData systemData();
/**
* Gets the provisioningState property: Provisioning state of the Kubernetes Environment.
*
* @return the provisioningState value.
*/
ConnectedEnvironmentProvisioningState provisioningState();
/**
* Gets the deploymentErrors property: Any errors that occurred during deployment or deployment validation.
*
* @return the deploymentErrors value.
*/
String deploymentErrors();
/**
* Gets the defaultDomain property: Default Domain Name for the cluster.
*
* @return the defaultDomain value.
*/
String defaultDomain();
/**
* Gets the staticIp property: Static IP of the connectedEnvironment.
*
* @return the staticIp value.
*/
String staticIp();
/**
* Gets the daprAIConnectionString property: Application Insights connection string used by Dapr to export Service
* to Service communication telemetry.
*
* @return the daprAIConnectionString value.
*/
String daprAIConnectionString();
/**
* Gets the customDomainConfiguration property: Custom domain configuration for the environment.
*
* @return the customDomainConfiguration value.
*/
CustomDomainConfiguration customDomainConfiguration();
/**
* Gets the region of the resource.
*
* @return the region of the resource.
*/
Region region();
/**
* Gets the name of the resource region.
*
* @return the name of the resource region.
*/
String regionName();
/**
* Gets the name of the resource group.
*
* @return the name of the resource group.
*/
String resourceGroupName();
/**
* Gets the inner com.azure.resourcemanager.appcontainers.fluent.models.ConnectedEnvironmentInner object.
*
* @return the inner object.
*/
ConnectedEnvironmentInner innerModel();
/**
* The entirety of the ConnectedEnvironment definition.
*/
interface Definition extends DefinitionStages.Blank, DefinitionStages.WithLocation,
DefinitionStages.WithResourceGroup, DefinitionStages.WithCreate {
}
/**
* The ConnectedEnvironment definition stages.
*/
interface DefinitionStages {
/**
* The first stage of the ConnectedEnvironment definition.
*/
interface Blank extends WithLocation {
}
/**
* The stage of the ConnectedEnvironment definition allowing to specify location.
*/
interface WithLocation {
/**
* Specifies the region for the resource.
*
* @param location The geo-location where the resource lives.
* @return the next definition stage.
*/
WithResourceGroup withRegion(Region location);
/**
* Specifies the region for the resource.
*
* @param location The geo-location where the resource lives.
* @return the next definition stage.
*/
WithResourceGroup withRegion(String location);
}
/**
* The stage of the ConnectedEnvironment definition allowing to specify parent resource.
*/
interface WithResourceGroup {
/**
* Specifies resourceGroupName.
*
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @return the next definition stage.
*/
WithCreate withExistingResourceGroup(String resourceGroupName);
}
/**
* The stage of the ConnectedEnvironment definition which contains all the minimum required properties for the
* resource to be created, but also allows for any other optional properties to be specified.
*/
interface WithCreate
extends DefinitionStages.WithTags, DefinitionStages.WithExtendedLocation, DefinitionStages.WithStaticIp,
DefinitionStages.WithDaprAIConnectionString, DefinitionStages.WithCustomDomainConfiguration {
/**
* Executes the create request.
*
* @return the created resource.
*/
ConnectedEnvironment create();
/**
* Executes the create request.
*
* @param context The context to associate with this operation.
* @return the created resource.
*/
ConnectedEnvironment create(Context context);
}
/**
* The stage of the ConnectedEnvironment definition allowing to specify tags.
*/
interface WithTags {
/**
* Specifies the tags property: Resource tags..
*
* @param tags Resource tags.
* @return the next definition stage.
*/
WithCreate withTags(Map tags);
}
/**
* The stage of the ConnectedEnvironment definition allowing to specify extendedLocation.
*/
interface WithExtendedLocation {
/**
* Specifies the extendedLocation property: The complex type of the extended location..
*
* @param extendedLocation The complex type of the extended location.
* @return the next definition stage.
*/
WithCreate withExtendedLocation(ExtendedLocation extendedLocation);
}
/**
* The stage of the ConnectedEnvironment definition allowing to specify staticIp.
*/
interface WithStaticIp {
/**
* Specifies the staticIp property: Static IP of the connectedEnvironment.
*
* @param staticIp Static IP of the connectedEnvironment.
* @return the next definition stage.
*/
WithCreate withStaticIp(String staticIp);
}
/**
* The stage of the ConnectedEnvironment definition allowing to specify daprAIConnectionString.
*/
interface WithDaprAIConnectionString {
/**
* Specifies the daprAIConnectionString property: Application Insights connection string used by Dapr to
* export Service to Service communication telemetry.
*
* @param daprAIConnectionString Application Insights connection string used by Dapr to export Service to
* Service communication telemetry.
* @return the next definition stage.
*/
WithCreate withDaprAIConnectionString(String daprAIConnectionString);
}
/**
* The stage of the ConnectedEnvironment definition allowing to specify customDomainConfiguration.
*/
interface WithCustomDomainConfiguration {
/**
* Specifies the customDomainConfiguration property: Custom domain configuration for the environment.
*
* @param customDomainConfiguration Custom domain configuration for the environment.
* @return the next definition stage.
*/
WithCreate withCustomDomainConfiguration(CustomDomainConfiguration customDomainConfiguration);
}
}
/**
* Begins update for the ConnectedEnvironment resource.
*
* @return the stage of resource update.
*/
ConnectedEnvironment.Update update();
/**
* The template for ConnectedEnvironment update.
*/
interface Update extends UpdateStages.WithTags, UpdateStages.WithExtendedLocation, UpdateStages.WithStaticIp,
UpdateStages.WithDaprAIConnectionString, UpdateStages.WithCustomDomainConfiguration {
/**
* Executes the update request.
*
* @return the updated resource.
*/
ConnectedEnvironment apply();
/**
* Executes the update request.
*
* @param context The context to associate with this operation.
* @return the updated resource.
*/
ConnectedEnvironment apply(Context context);
}
/**
* The ConnectedEnvironment update stages.
*/
interface UpdateStages {
/**
* The stage of the ConnectedEnvironment update allowing to specify tags.
*/
interface WithTags {
/**
* Specifies the tags property: Resource tags..
*
* @param tags Resource tags.
* @return the next definition stage.
*/
Update withTags(Map tags);
}
/**
* The stage of the ConnectedEnvironment update allowing to specify extendedLocation.
*/
interface WithExtendedLocation {
/**
* Specifies the extendedLocation property: The complex type of the extended location..
*
* @param extendedLocation The complex type of the extended location.
* @return the next definition stage.
*/
Update withExtendedLocation(ExtendedLocation extendedLocation);
}
/**
* The stage of the ConnectedEnvironment update allowing to specify staticIp.
*/
interface WithStaticIp {
/**
* Specifies the staticIp property: Static IP of the connectedEnvironment.
*
* @param staticIp Static IP of the connectedEnvironment.
* @return the next definition stage.
*/
Update withStaticIp(String staticIp);
}
/**
* The stage of the ConnectedEnvironment update allowing to specify daprAIConnectionString.
*/
interface WithDaprAIConnectionString {
/**
* Specifies the daprAIConnectionString property: Application Insights connection string used by Dapr to
* export Service to Service communication telemetry.
*
* @param daprAIConnectionString Application Insights connection string used by Dapr to export Service to
* Service communication telemetry.
* @return the next definition stage.
*/
Update withDaprAIConnectionString(String daprAIConnectionString);
}
/**
* The stage of the ConnectedEnvironment update allowing to specify customDomainConfiguration.
*/
interface WithCustomDomainConfiguration {
/**
* Specifies the customDomainConfiguration property: Custom domain configuration for the environment.
*
* @param customDomainConfiguration Custom domain configuration for the environment.
* @return the next definition stage.
*/
Update withCustomDomainConfiguration(CustomDomainConfiguration customDomainConfiguration);
}
}
/**
* Refreshes the resource to sync with Azure.
*
* @return the refreshed resource.
*/
ConnectedEnvironment refresh();
/**
* Refreshes the resource to sync with Azure.
*
* @param context The context to associate with this operation.
* @return the refreshed resource.
*/
ConnectedEnvironment refresh(Context context);
/**
* Checks the resource connectedEnvironmentName availability.
*
* Checks if resource connectedEnvironmentName is available.
*
* @param checkNameAvailabilityRequest The check connectedEnvironmentName availability request.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.resourcemanager.appcontainers.models.DefaultErrorResponseErrorException thrown if the request
* is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the check availability result along with {@link Response}.
*/
Response
checkNameAvailabilityWithResponse(CheckNameAvailabilityRequest checkNameAvailabilityRequest, Context context);
/**
* Checks the resource connectedEnvironmentName availability.
*
* Checks if resource connectedEnvironmentName is available.
*
* @param checkNameAvailabilityRequest The check connectedEnvironmentName availability request.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.resourcemanager.appcontainers.models.DefaultErrorResponseErrorException thrown if the request
* is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the check availability result.
*/
CheckNameAvailabilityResponse checkNameAvailability(CheckNameAvailabilityRequest checkNameAvailabilityRequest);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy