com.azure.resourcemanager.network.models.ApplicationGatewayPathRule 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.annotation.Fluent;
import com.azure.resourcemanager.network.fluent.models.ApplicationGatewayPathRuleInner;
import com.azure.resourcemanager.resources.fluentcore.arm.models.ChildResource;
import com.azure.resourcemanager.resources.fluentcore.model.Attachable;
import com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel;
import com.azure.resourcemanager.resources.fluentcore.model.Settable;
import java.util.List;
/** A client-side representation of an application gateway's URL path map. */
@Fluent
public interface ApplicationGatewayPathRule
extends HasInnerModel, ChildResource {
/** @return backend address pool resource of URL path map path rule */
ApplicationGatewayBackend backend();
/** @return backend http settings resource of URL path map path rule */
ApplicationGatewayBackendHttpConfiguration backendHttpConfiguration();
/** @return redirect configuration resource of URL path map path rule */
ApplicationGatewayRedirectConfiguration redirectConfiguration();
/** @return paths for URL path map rule. */
List paths();
/** Grouping of application gateway URL path map definition stages. */
interface DefinitionStages {
/**
* The first stage of an application gateway URL path map definition.
*
* @param the stage of the parent application gateway definition to return to after attaching this
* definition
*/
interface Blank extends WithBackendHttpConfiguration {
}
/**
* The stage of an application gateway path rule definition allowing to specify the the paths to associate with
* path rule.
*
* @param the stage of the application gateway URL path map definition to return to after attaching
* this definition
*/
interface WithPath {
/**
* @param path for the path rule
* @return the next stage of the definition
*/
WithAttach withPath(String path);
/**
* @param paths for the path rule
* @return the next stage of the definition
*/
WithAttach withPaths(String... paths);
}
/**
* The stage of an application gateway request routing rule definition allowing to specify the backend HTTP
* settings configuration to associate the routing rule with.
*
* @param the stage of the application gateway definition to return to after attaching this definition
*/
interface WithBackendHttpConfiguration {
/**
* Associates the specified backend HTTP settings configuration with this path rule.
*
* If the backend configuration does not exist yet, it must be defined in the optional part of the
* application gateway definition. The request routing rule references it only by name.
*
* @param name the name of a backend HTTP settings configuration
* @return the next stage of the definition
*/
WithBackend toBackendHttpConfiguration(String name);
}
/**
* The stage of an application gateway request routing rule definition allowing to specify the backend to
* associate the routing rule with.
*
* @param the stage of the application gateway definition to return to after attaching this definition
*/
interface WithBackend {
/**
* Associates the path rule with a backend on this application gateway.
*
* If the backend does not yet exist, it will be automatically created.
*
* @param name the name of an existing backend
* @return the next stage of the definition
*/
WithPath toBackend(String name);
}
/**
* The stage of path rule of URL path map definition allowing to associate the rule with a redirect
* configuration.
*
* @param the stage of the application gateway URL path map definition to return to after attaching
* this definition
*/
interface WithRedirectConfig {
/**
* Associates the specified redirect configuration with this path rule.
*
* @param name the name of a redirect configuration on this application gateway
* @return the next stage of the definition
*/
WithAttach withRedirectConfiguration(String name);
}
/**
* The final stage of a path rule of URL path map definition.
*
* At this stage, any remaining optional settings can be specified, or the definition can be attached to the
* parent application gateway definition.
*
* @param the stage of the parent application gateway definition to return to after attaching this
* definition
*/
interface WithAttach
extends Attachable.InDefinition, WithPath, WithRedirectConfig {
}
}
/**
* The entirety of a path rule of URL path map definition.
*
* @param the stage of the parent application gateway definition to return to after attaching this
* definition
*/
interface Definition
extends DefinitionStages.Blank,
DefinitionStages.WithBackendHttpConfiguration,
DefinitionStages.WithBackend,
DefinitionStages.WithAttach {
}
/** The entirety of path rule of URL path map update as part of an application gateway update. */
interface Update extends Settable {
}
/** Grouping of path rule of URL path map definition stages applicable as part of an application gateway update. */
interface UpdateDefinitionStages {
/**
* The first stage of path rule of URL path map definition.
*
* @param the stage of the parent application gateway definition to return to after attaching this
* definition
*/
interface Blank extends WithBackendHttpConfiguration {
}
/**
* The stage of path rule of URL path map allowing to specify the backend HTTP settings configuration to
* associate the path rule with.
*
* @param the stage of the application gateway definition to return to after attaching this definition
*/
interface WithBackendHttpConfiguration {
/**
* Associates the specified backend HTTP settings configuration with this path rule.
*
* If the backend configuration does not exist yet, it must be defined in the optional part of the
* application gateway definition. The path rule references it only by name.
*
* @param name the name of a backend HTTP settings configuration
* @return the next stage of the definition
*/
WithBackend toBackendHttpConfiguration(String name);
}
/**
* The stage of an application gateway path rule definition allowing to specify the backend to associate with
* path rule.
*
* @param the stage of the application gateway URL path map definition to return to after attaching
* this definition
*/
interface WithBackend {
/**
* Associates the path rule with a backend on this application gateway.
*
* If the backend does not yet exist, it will be automatically created.
*
* @param name the name of an existing backend
* @return the next stage of the definition
*/
WithPath toBackend(String name);
}
/**
* The stage of an application gateway path rule definition allowing to specify the the paths to associate with
* path rule.
*
* @param the stage of the application gateway URL path map definition to return to after attaching
* this definition
*/
interface WithPath {
/**
* @param path for the path rule
* @return the next stage of the definition
*/
WithAttach withPath(String path);
/**
* @param paths for the path rule
* @return the next stage of the definition
*/
WithAttach withPaths(String... paths);
}
/**
* The stage of path rule of URL path map definition allowing to associate the rule with a redirect
* configuration.
*
* @param the stage of the application gateway definition to return to after attaching this definition
*/
interface WithRedirectConfig {
/**
* Associates the specified redirect configuration with this path rule.
*
* @param name the name of a redirect configuration on this application gateway
* @return the next stage of the definition
*/
WithAttach withRedirectConfiguration(String name);
}
/**
* The final stage of path rule of URL path map definition.
*
* At this stage, any remaining optional settings can be specified, or the definition can be attached to the
* parent application gateway definition.
*
* @param the stage of the parent application gateway definition to return to after attaching this
* definition
*/
interface WithAttach
extends Attachable.InUpdate, UpdateDefinitionStages.WithRedirectConfig {
}
}
/**
* The entirety of path rule of URL path map definition as part of an application gateway update.
*
* @param the stage of the parent application gateway URL path map definition to return to after attaching
* this definition
*/
interface UpdateDefinition
extends UpdateDefinitionStages.Blank,
UpdateDefinitionStages.WithBackendHttpConfiguration,
UpdateDefinitionStages.WithBackend,
UpdateDefinitionStages.WithPath,
UpdateDefinitionStages.WithAttach {
}
}