com.azure.resourcemanager.network.models.PrivateEndpoint Maven / Gradle / Ivy
Show all versions of azure-resourcemanager-network Show documentation
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
package com.azure.resourcemanager.network.models;
import com.azure.core.management.SubResource;
import com.azure.resourcemanager.network.NetworkManager;
import com.azure.resourcemanager.network.fluent.models.PrivateEndpointInner;
import com.azure.resourcemanager.resources.fluentcore.arm.models.ChildResource;
import com.azure.resourcemanager.resources.fluentcore.arm.models.GroupableResource;
import com.azure.resourcemanager.resources.fluentcore.arm.models.Resource;
import com.azure.resourcemanager.resources.fluentcore.model.Appliable;
import com.azure.resourcemanager.resources.fluentcore.model.Attachable;
import com.azure.resourcemanager.resources.fluentcore.model.Creatable;
import com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel;
import com.azure.resourcemanager.resources.fluentcore.model.Refreshable;
import com.azure.resourcemanager.resources.fluentcore.model.Settable;
import com.azure.resourcemanager.resources.fluentcore.model.Updatable;
import java.util.List;
import java.util.Map;
/** An immutable client-side representation of an Azure private endpoint. */
public interface PrivateEndpoint extends
GroupableResource,
Refreshable,
Updatable {
/** A client-side representation of a private link service connection. */
interface PrivateLinkServiceConnection extends
HasInnerModel,
ChildResource {
/**
* @return the state of the connection.
*/
PrivateLinkServiceConnectionState state();
/**
* @return the resource ID that this connection connects to.
*/
String privateLinkResourceId();
/**
* @return the collection of sub resource names.
*/
List subResourceNames();
/**
* @return the request message.
*/
String requestMessage();
/**
* @return the provisioning state.
*/
ProvisioningState provisioningState();
/**
* @return whether connection is manual approval.
*/
boolean isManualApproval();
/** Grouping of private link service connection definition stages. */
interface DefinitionStages {
/**
* The first stage of the definition.
*
* @param the stage of the parent definition to return to after attaching this definition
*/
interface Blank
extends PrivateLinkServiceConnection.DefinitionStages.WithPrivateLinkServiceResource {
}
/**
* The stage of the definition allowing to specify the resource of the private link service.
*
* @param the stage of the parent definition to return to after attaching this definition
*/
interface WithPrivateLinkServiceResource {
/**
* Specifies the resource of the private link service.
*
* @param privateLinkServiceResource the resource of the private link service
* @return the next stage of the definition
*/
PrivateLinkServiceConnection.DefinitionStages.WithSubResource withResource(
Resource privateLinkServiceResource);
/**
* Specifies the resource of the private link service.
*
* @param privateLinkServiceResourceId the resource ID of the private link service
* @return the next stage of the definition
*/
PrivateLinkServiceConnection.DefinitionStages.WithSubResource withResourceId(
String privateLinkServiceResourceId);
}
/**
* The stage of the definition allowing to specify the sub resource that this private endpoint
* should connect to.
*
* @param the stage of the parent definition to return to after attaching this definition
*/
interface WithSubResource {
/**
* Specifies the sub resource.
*
* @param subResourceName the name of the sub resource
* @return the next stage of the definition
*/
PrivateLinkServiceConnection.DefinitionStages.WithAttach withSubResource(
PrivateLinkSubResourceName subResourceName);
/**
* Specifies no sub resource, used for Private Link service.
*
* @return the next stage of the definition
*/
PrivateLinkServiceConnection.DefinitionStages.WithAttach withoutSubResource();
}
/**
* The stage of the definition allowing to specify the approval method.
*
* @param the stage of the parent definition to return to after attaching this definition
*/
interface WithApprovalMethod {
/**
* Specifies the approval method.
*
* @param requestMessage the request message for manual approval
* @return the next stage of the definition
*/
PrivateLinkServiceConnection.DefinitionStages.WithAttach withManualApproval(
String requestMessage);
}
/**
* The final stage of the definition.
*
* At this stage, any remaining optional settings can be specified, or the definition can be attached
* to the parent definition.
*
* @param the stage of the parent definition to return to after attaching this definition
*/
interface WithAttach extends
Attachable.InDefinition,
WithApprovalMethod {
}
}
/**
* The entirety of the definition.
*
* @param the stage of the parent definition to return to after attaching this definition
*/
interface Definition extends
PrivateLinkServiceConnection.DefinitionStages.Blank,
PrivateLinkServiceConnection.DefinitionStages.WithPrivateLinkServiceResource,
PrivateLinkServiceConnection.DefinitionStages.WithSubResource,
PrivateLinkServiceConnection.DefinitionStages.WithApprovalMethod,
PrivateLinkServiceConnection.DefinitionStages.WithAttach {
}
/** Grouping of private link service connection update stages. */
interface UpdateStages {
/**
* The stage of the definition allowing to specify the approval method.
*/
interface WithApprovalMethod {
/**
* Specifies the request message.
*
* @param requestMessage the request message
* @return the next stage of the update
*/
PrivateLinkServiceConnection.Update withRequestMessage(String requestMessage);
}
}
/** The entirety of a private link service update. */
interface Update extends
PrivateLinkServiceConnection.UpdateStages.WithApprovalMethod,
Settable {
}
}
/**
* @return the resource collection API of private DNS zone group.
*/
PrivateDnsZoneGroups privateDnsZoneGroups();
/**
* @return the reference of the subnet.
*/
SubResource subnet();
/**
* @return the collection of reference of the network interfaces.
*/
List networkInterfaces();
/**
* @return the provisioning state.
*/
ProvisioningState provisioningState();
/**
* @return the collection of the private link service connections.
*/
Map privateLinkServiceConnections();
/**
* @return the collection of custom DNS configurations.
*/
List customDnsConfigurations();
/**
* Container interface for all the definitions that need to be implemented.
*/
interface Definition extends
DefinitionStages.Blank,
DefinitionStages.WithGroup,
DefinitionStages.WithSubnet,
DefinitionStages.WithPrivateLinkServiceConnection,
DefinitionStages.WithCreate {
}
/**
* Grouping of all the private endpoint definition stages.
*/
interface DefinitionStages {
/**
* The first stage of the private endpoint definition.
*/
interface Blank extends GroupableResource.DefinitionWithRegion {
}
/**
* The stage of a private endpoint definition allowing to specify the resource group.
*/
interface WithGroup extends GroupableResource.DefinitionStages.WithGroup {
}
/**
* The stage of a private endpoint definition allowing to specify the subnet.
*/
interface WithSubnet {
/**
* Specifies the subnet, from which the private IP will be allocated.
*
* @param subnet the subnet from which the private IP will be allocated
* @return the next stage of private endpoint definition
*/
WithPrivateLinkServiceConnection withSubnet(Subnet subnet);
/**
* Specifies the subnet, from which the private IP will be allocated.
*
* @param subnetId the ID of subnet from which the private IP will be allocated
* @return the next stage of private endpoint definition
*/
WithPrivateLinkServiceConnection withSubnetId(String subnetId);
}
/**
* The stage of a private endpoint definition allowing to specify the private endpoint connection.
*/
interface WithPrivateLinkServiceConnection {
/**
* Specifies the connection to remote resource.
*
* @param name the name of the connection
* @return the first stage of private link service connection definition
*/
PrivateLinkServiceConnection.DefinitionStages.Blank
definePrivateLinkServiceConnection(String name);
}
/**
* A private endpoint definition with sufficient inputs to create a new private endpoint in the cloud, but
* exposing additional optional inputs to specify.
*/
interface WithCreate extends Creatable {
}
}
/** The template for a private endpoint update operation, containing all the settings that can be modified. */
interface Update extends
Appliable,
UpdateStages.WithPrivateLinkServiceConnection,
Resource.UpdateWithTags {
}
/**
* Grouping of all the private endpoint update stages.
*/
interface UpdateStages {
/**
* The stage of a private endpoint update allowing to specify the private endpoint connection.
*/
interface WithPrivateLinkServiceConnection {
/**
* Removes the connection to remote resource.
*
* @param name the name of the connection
* @return the next stage of update
*/
Update withoutPrivateLinkServiceConnection(String name);
/**
* Specifies the connection to remote resource.
*
* @param name the name of the connection
* @return the first stage of private link service connection definition
*/
PrivateLinkServiceConnection.DefinitionStages.Blank
definePrivateLinkServiceConnection(String name);
/**
* Updates the connection to remote resource.
*
* @param name the name of the connection
* @return the first stage of private link service connection update
*/
PrivateLinkServiceConnection.Update updatePrivateLinkServiceConnection(String name);
}
}
}