Copyright (c) Microsoft Corporation. All rights reserved.
Licensed under the MIT License. See License.txt in the project root for
license information.
/**
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for
* license information.
*/
package com.microsoft.azure.management.network;
import com.microsoft.azure.management.apigeneration.Fluent;
import com.microsoft.azure.management.apigeneration.Method;
import com.microsoft.azure.management.network.implementation.SecurityRuleInner;
import com.microsoft.azure.management.resources.fluentcore.arm.models.ChildResource;
import com.microsoft.azure.management.resources.fluentcore.model.Attachable;
import com.microsoft.azure.management.resources.fluentcore.model.Settable;
import com.microsoft.azure.management.resources.fluentcore.model.HasInner;
import java.util.List;
import java.util.Set;
A network security rule in a network security group.
/**
* A network security rule in a network security group.
*/
@Fluent
public interface NetworkSecurityRule extends
HasInner<SecurityRuleInner>,
ChildResource<NetworkSecurityGroup> {
Returns: the direction of the network traffic that the network security rule applies to.
/**
* @return the direction of the network traffic that the network security rule applies to.
*/
SecurityRuleDirection direction();
Returns: the network protocol the rule applies to
/**
* @return the network protocol the rule applies to
*/
SecurityRuleProtocol protocol();
Returns: the user-defined description of the security rule
/**
* @return the user-defined description of the security rule
*/
String description();
Returns: the type of access the rule enforces
/**
* @return the type of access the rule enforces
*/
SecurityRuleAccess access();
Returns: the source address prefix the rule applies to, expressed using the CIDR notation in the format: "###.###.###.###/##",
and "*" means "any"
/**
* @return the source address prefix the rule applies to, expressed using the CIDR notation in the format: "###.###.###.###/##",
* and "*" means "any"
*/
String sourceAddressPrefix();
Returns: the list of source address prefixes the rule applies to, expressed using the CIDR notation in the format: "###.###.###.###/##",
and "*" means "any", or IP addresses
/**
* @return the list of source address prefixes the rule applies to, expressed using the CIDR notation in the format: "###.###.###.###/##",
* and "*" means "any", or IP addresses
*/
List<String> sourceAddressPrefixes();
Returns: the source port range that the rule applies to, in the format "##-##", where "*" means "any"
/**
* @return the source port range that the rule applies to, in the format "##-##", where "*" means "any"
*/
String sourcePortRange();
Returns: the source port ranges that the rule applies to, in the format "##-##", where "*" means "any"
/**
* @return the source port ranges that the rule applies to, in the format "##-##", where "*" means "any"
*/
List<String> sourcePortRanges();
Returns: the destination address prefix the rule applies to, expressed using the CIDR notation in the format: "###.###.###.###/##",
and "*" means "any"
/**
* @return the destination address prefix the rule applies to, expressed using the CIDR notation in the format: "###.###.###.###/##",
* and "*" means "any"
*/
String destinationAddressPrefix();
Returns: the list of destination address prefixes the rule applies to, expressed using the CIDR notation in the format: "###.###.###.###/##",
and "*" means "any", or IP addresses
/**
* @return the list of destination address prefixes the rule applies to, expressed using the CIDR notation in the format: "###.###.###.###/##",
* and "*" means "any", or IP addresses
*/
List<String> destinationAddressPrefixes();
Returns: the destination port range that the rule applies to, in the format "##-##", where "*" means any
/**
* @return the destination port range that the rule applies to, in the format "##-##", where "*" means any
*/
String destinationPortRange();
Returns: the destination port ranges that the rule applies to, in the format "##-##", where "*" means any
/**
* @return the destination port ranges that the rule applies to, in the format "##-##", where "*" means any
*/
List<String> destinationPortRanges();
Returns: the priority number of this rule based on which this rule will be applied relative to the priority numbers of any other rules specified
for this network security group
/**
* @return the priority number of this rule based on which this rule will be applied relative to the priority numbers of any other rules specified
* for this network security group
*/
int priority();
Returns: list of application security group ids specified as source
/**
* @return list of application security group ids specified as source
*/
Set<String> sourceApplicationSecurityGroupIds();
Returns: list of application security group ids specified as destination
/**
* @return list of application security group ids specified as destination
*/
Set<String> destinationApplicationSecurityGroupIds();
The entirety of a network security rule definition.
Type parameters: - <ParentT> – the return type of the final
Attachable.attach()
/**
* The entirety of a network security rule definition.
* @param <ParentT> the return type of the final {@link Attachable#attach()}
*/
interface Definition<ParentT> extends
DefinitionStages.Blank<ParentT>,
DefinitionStages.WithAttach<ParentT>,
DefinitionStages.WithDirectionAccess<ParentT>,
DefinitionStages.WithSourceAddressOrSecurityGroup<ParentT>,
DefinitionStages.WithSourcePort<ParentT>,
DefinitionStages.WithDestinationAddressOrSecurityGroup<ParentT>,
DefinitionStages.WithDestinationPort<ParentT>,
DefinitionStages.WithProtocol<ParentT> {
}
Grouping of security rule definition stages applicable as part of a network security group creation.
/**
* Grouping of security rule definition stages applicable as part of a network security group creation.
*/
interface DefinitionStages {
The first stage of a security rule definition.
Type parameters: - <ParentT> – the stage of the parent definition to return to after attaching this definition
/**
* The first stage of a security rule definition.
* @param <ParentT> the stage of the parent definition to return to after attaching this definition
*/
interface Blank<ParentT> extends WithDirectionAccess<ParentT> {
}
The stage of the security rule definition allowing the protocol that the rule applies to to be specified.
Type parameters: - <ParentT> – the stage of the parent definition to return to after attaching this definition
/**
* The stage of the security rule definition allowing the protocol that the rule applies to to be specified.
* @param <ParentT> the stage of the parent definition to return to after attaching this definition
*/
interface WithProtocol<ParentT> {
Specifies the protocol that this rule applies to.
Params: - protocol – one of the supported protocols
Returns: the next stage of the definition
/**
* Specifies the protocol that this rule applies to.
* @param protocol one of the supported protocols
* @return the next stage of the definition
*/
WithAttach<ParentT> withProtocol(SecurityRuleProtocol protocol);
Makes this rule apply to any supported protocol.
Returns: the next stage of the definition
/**
* Makes this rule apply to any supported protocol.
* @return the next stage of the definition
*/
WithAttach<ParentT> withAnyProtocol();
}
The stage of the network rule definition allowing the destination port(s) to be specified.
Type parameters: - <ParentT> – the stage of the parent definition to return to after attaching this definition
/**
* The stage of the network rule definition allowing the destination port(s) to be specified.
* @param <ParentT> the stage of the parent definition to return to after attaching this definition
*/
interface WithDestinationPort<ParentT> {
Specifies the destination port to which this rule applies.
Params: - port – the destination port number
Returns: the next stage of the definition
/**
* Specifies the destination port to which this rule applies.
* @param port the destination port number
* @return the next stage of the definition
*/
WithProtocol<ParentT> toPort(int port);
Makes this rule apply to any destination port.
Returns: the next stage of the definition
/**
* Makes this rule apply to any destination port.
* @return the next stage of the definition
*/
@Method
WithProtocol<ParentT> toAnyPort();
Specifies the destination port range to which this rule applies.
Params: - from – the starting port number
- to – the ending port number
Returns: the next stage of the definition
/**
* Specifies the destination port range to which this rule applies.
* @param from the starting port number
* @param to the ending port number
* @return the next stage of the definition
*/
WithProtocol<ParentT> toPortRange(int from, int to);
Specifies the destination port ranges to which this rule applies.
Params: - ranges – the destination port ranges
Returns: the next stage of the definition
/**
* Specifies the destination port ranges to which this rule applies.
* @param ranges the destination port ranges
* @return the next stage of the definition
*/
WithProtocol<ParentT> toPortRanges(String... ranges);
}
The stage of the network rule definition allowing the destination address to be specified.
Note: network security rule must specify a non empty value for exactly one of:
DestinationAddressPrefixes, DestinationAddressPrefix, DestinationApplicationSecurityGroups.
Type parameters: - <ParentT> – the stage of the parent definition to return to after attaching this definition
/**
* The stage of the network rule definition allowing the destination address to be specified.
* Note: network security rule must specify a non empty value for exactly one of:
* DestinationAddressPrefixes, DestinationAddressPrefix, DestinationApplicationSecurityGroups.
* @param <ParentT> the stage of the parent definition to return to after attaching this definition
*/
interface WithDestinationAddressOrSecurityGroup<ParentT> {
Specifies the traffic destination address range to which this rule applies.
Params: - cidr – an IP address range expressed in the CIDR notation
Returns: the next stage of the definition
/**
* Specifies the traffic destination address range to which this rule applies.
* @param cidr an IP address range expressed in the CIDR notation
* @return the next stage of the definition
*/
WithDestinationPort<ParentT> toAddress(String cidr);
Specifies the traffic destination address prefixes to which this rule applies.
Params: - addresses – IP address prefixes in CIDR notation or IP addresses
Returns: the next stage of the definition
/**
* Specifies the traffic destination address prefixes to which this rule applies.
* @param addresses IP address prefixes in CIDR notation or IP addresses
* @return the next stage of the definition
*/
WithDestinationPort<ParentT> toAddresses(String... addresses);
Makes the rule apply to any traffic destination address.
Returns: the next stage of the definition
/**
* Makes the rule apply to any traffic destination address.
* @return the next stage of the definition
*/
@Method
WithDestinationPort<ParentT> toAnyAddress();
Sets the application security group specified as destination.
Params: - id – application security group id
Returns: the next stage of the definition
/**
* Sets the application security group specified as destination.
* @param id application security group id
* @return the next stage of the definition
*/
WithDestinationPort<ParentT> withDestinationApplicationSecurityGroup(String id);
}
The stage of the network rule definition allowing the source port(s) to be specified.
Type parameters: - <ParentT> – the stage of the parent definition to return to after attaching this definition
/**
* The stage of the network rule definition allowing the source port(s) to be specified.
* @param <ParentT> the stage of the parent definition to return to after attaching this definition
*/
interface WithSourcePort<ParentT> {
Specifies the source port to which this rule applies.
Params: - port – the source port number
Returns: the next stage of the definition
/**
* Specifies the source port to which this rule applies.
* @param port the source port number
* @return the next stage of the definition
*/
WithDestinationAddressOrSecurityGroup<ParentT> fromPort(int port);
Makes this rule apply to any source port.
Returns: the next stage of the definition
/**
* Makes this rule apply to any source port.
* @return the next stage of the definition
*/
@Method
WithDestinationAddressOrSecurityGroup<ParentT> fromAnyPort();
Specifies the source port range to which this rule applies.
Params: - from – the starting port number
- to – the ending port number
Returns: the next stage of the definition
/**
* Specifies the source port range to which this rule applies.
* @param from the starting port number
* @param to the ending port number
* @return the next stage of the definition
*/
WithDestinationAddressOrSecurityGroup<ParentT> fromPortRange(int from, int to);
Specifies the source port ranges to which this rule applies.
Params: - ranges – the starting port ranges
Returns: the next stage of the definition
/**
* Specifies the source port ranges to which this rule applies.
* @param ranges the starting port ranges
* @return the next stage of the definition
*/
WithDestinationAddressOrSecurityGroup<ParentT> fromPortRanges(String... ranges);
}
The stage of the network rule definition allowing the source address to be specified.
Note: network security rule must specify a non empty value for exactly one of:
SourceAddressPrefixes, SourceAddressPrefix, SourceApplicationSecurityGroups.
Type parameters: - <ParentT> – the stage of the parent definition to return to after attaching this definition
/**
* The stage of the network rule definition allowing the source address to be specified.
* Note: network security rule must specify a non empty value for exactly one of:
* SourceAddressPrefixes, SourceAddressPrefix, SourceApplicationSecurityGroups.
* @param <ParentT> the stage of the parent definition to return to after attaching this definition
*/
interface WithSourceAddressOrSecurityGroup<ParentT> {
Specifies the traffic source address prefix to which this rule applies.
Params: - cidr – an IP address prefix expressed in the CIDR notation
Returns: the next stage of the definition
/**
* Specifies the traffic source address prefix to which this rule applies.
* @param cidr an IP address prefix expressed in the CIDR notation
* @return the next stage of the definition
*/
@Method
WithSourcePort<ParentT> fromAddress(String cidr);
Specifies that the rule applies to any traffic source address.
Returns: the next stage of the definition
/**
* Specifies that the rule applies to any traffic source address.
* @return the next stage of the definition
*/
@Method
WithSourcePort<ParentT> fromAnyAddress();
Specifies the traffic source address prefixes to which this rule applies.
Params: - addresses – IP address prefixes in CIDR notation or IP addresses
Returns: the next stage of the definition
/**
* Specifies the traffic source address prefixes to which this rule applies.
* @param addresses IP address prefixes in CIDR notation or IP addresses
* @return the next stage of the definition
*/
@Method
WithSourcePort<ParentT> fromAddresses(String... addresses);
Sets the application security group specified as source.
Params: - id – application security group id
Returns: the next stage of the definition
/**
* Sets the application security group specified as source.
* @param id application security group id
* @return the next stage of the definition
*/
WithSourcePort<ParentT> withSourceApplicationSecurityGroup(String id);
}
The stage of the network rule definition allowing the direction and the access type to be specified.
Type parameters: - <ParentT> – the stage of the parent definition to return to after attaching this definition
/**
* The stage of the network rule definition allowing the direction and the access type to be specified.
* @param <ParentT> the stage of the parent definition to return to after attaching this definition
*/
interface WithDirectionAccess<ParentT> {
Allows inbound traffic.
Returns: the next stage of the definition
/**
* Allows inbound traffic.
* @return the next stage of the definition
*/
@Method
WithSourceAddressOrSecurityGroup<ParentT> allowInbound();
Allows outbound traffic.
Returns: the next stage of the definition
/**
* Allows outbound traffic.
* @return the next stage of the definition
*/
@Method
WithSourceAddressOrSecurityGroup<ParentT> allowOutbound();
Blocks inbound traffic.
Returns: the next stage of the definition
/**
* Blocks inbound traffic.
* @return the next stage of the definition
*/
@Method
WithSourceAddressOrSecurityGroup<ParentT> denyInbound();
Blocks outbound traffic.
Returns: the next stage of the definition
/**
* Blocks outbound traffic.
* @return the next stage of the definition
*/
@Method
WithSourceAddressOrSecurityGroup<ParentT> denyOutbound();
}
The stage of the network rule definition allowing the priority to be specified.
Type parameters: - <ParentT> – the stage of the parent definition to return to after attaching this definition
/**
* The stage of the network rule definition allowing the priority to be specified.
* @param <ParentT> the stage of the parent definition to return to after attaching this definition
*/
interface WithPriority<ParentT> {
Specifies the priority to assign to this rule.
Security rules are applied in the order of their assigned priority.
Params: - priority – the priority number in the range 100 to 4096
Returns: the next stage
/**
* Specifies the priority to assign to this rule.
* <p>
* Security rules are applied in the order of their assigned priority.
* @param priority the priority number in the range 100 to 4096
* @return the next stage
*/
WithAttach<ParentT> withPriority(int priority);
}
The stage of the network rule definition allowing the description to be specified.
Type parameters: - <ParentT> – the stage of the parent definition to return to after attaching this definition
/**
* The stage of the network rule definition allowing the description to be specified.
* @param <ParentT> the stage of the parent definition to return to after attaching this definition
*/
interface WithDescription<ParentT> {
Specifies a description for this security rule.
Params: - description – the text description to associate with this security rule
Returns: the next stage
/**
* Specifies a description for this security rule.
* @param description the text description to associate with this security rule
* @return the next stage
*/
WithAttach<ParentT> withDescription(String description);
}
The final stage of the security rule definition.
At this stage, any remaining optional settings can be specified, or the security rule definition can be attached to the parent network security group definition using InDefinition.attach()
.
Type parameters: - <ParentT> – the return type of
InDefinition.attach()
/** The final stage of the security rule definition.
* <p>
* At this stage, any remaining optional settings can be specified, or the security rule definition
* can be attached to the parent network security group definition using {@link WithAttach#attach()}.
* @param <ParentT> the return type of {@link WithAttach#attach()}
*/
interface WithAttach<ParentT> extends
Attachable.InDefinition<ParentT>,
WithPriority<ParentT>,
WithDescription<ParentT> {
}
}
The entirety of a network security rule definition as part of a network security group update.
Type parameters: - <ParentT> – the return type of the final
InUpdate.attach()
/** The entirety of a network security rule definition as part of a network security group update.
* @param <ParentT> the return type of the final {@link UpdateDefinitionStages.WithAttach#attach()}
*/
interface UpdateDefinition<ParentT> extends
UpdateDefinitionStages.Blank<ParentT>,
UpdateDefinitionStages.WithDirectionAccess<ParentT>,
UpdateDefinitionStages.WithSourceAddressOrSecurityGroup<ParentT>,
UpdateDefinitionStages.WithSourcePort<ParentT>,
UpdateDefinitionStages.WithDestinationAddressOrSecurityGroup<ParentT>,
UpdateDefinitionStages.WithDestinationPort<ParentT>,
UpdateDefinitionStages.WithProtocol<ParentT>,
UpdateDefinitionStages.WithAttach<ParentT> {
}
Grouping of security rule definition stages applicable as part of a network security group update.
/**
* Grouping of security rule definition stages applicable as part of a network security group update.
*/
interface UpdateDefinitionStages {
The first stage of a security rule description as part of an update of a networking security group.
Type parameters: - <ParentT> – the return type of the final
Attachable.attach()
/**
* The first stage of a security rule description as part of an update of a networking security group.
* @param <ParentT> the return type of the final {@link Attachable#attach()}
*/
interface Blank<ParentT> extends WithDirectionAccess<ParentT> {
}
The stage of the network rule description allowing the direction and the access type to be specified.
Type parameters: - <ParentT> – the stage of the parent definition to return to after attaching this definition
/**
* The stage of the network rule description allowing the direction and the access type to be specified.
* @param <ParentT> the stage of the parent definition to return to after attaching this definition
*/
interface WithDirectionAccess<ParentT> {
Allows inbound traffic.
Returns: the next stage of the definition
/**
* Allows inbound traffic.
* @return the next stage of the definition
*/
@Method
WithSourceAddressOrSecurityGroup<ParentT> allowInbound();
Allows outbound traffic.
Returns: the next stage of the definition
/**
* Allows outbound traffic.
* @return the next stage of the definition
*/
@Method
WithSourceAddressOrSecurityGroup<ParentT> allowOutbound();
Blocks inbound traffic.
Returns: the next stage of the definition
/**
* Blocks inbound traffic.
* @return the next stage of the definition
*/
@Method
WithSourceAddressOrSecurityGroup<ParentT> denyInbound();
Blocks outbound traffic.
Returns: the next stage of the definition
/**
* Blocks outbound traffic.
* @return the next stage of the definition
*/
@Method
WithSourceAddressOrSecurityGroup<ParentT> denyOutbound();
}
The stage of the network rule definition allowing the source address to be specified.
Note: network security rule must specify a non empty value for exactly one of:
SourceAddressPrefixes, SourceAddressPrefix, SourceApplicationSecurityGroups.
Type parameters: - <ParentT> – the stage of the parent definition to return to after attaching this definition
/**
* The stage of the network rule definition allowing the source address to be specified.
* Note: network security rule must specify a non empty value for exactly one of:
* SourceAddressPrefixes, SourceAddressPrefix, SourceApplicationSecurityGroups.
* @param <ParentT> the stage of the parent definition to return to after attaching this definition
*/
interface WithSourceAddressOrSecurityGroup<ParentT> {
Specifies the traffic source address prefix to which this rule applies.
Params: - cidr – an IP address prefix expressed in the CIDR notation
Returns: the next stage of the definition
/**
* Specifies the traffic source address prefix to which this rule applies.
* @param cidr an IP address prefix expressed in the CIDR notation
* @return the next stage of the definition
*/
@Method
WithSourcePort<ParentT> fromAddress(String cidr);
Specifies the traffic source address prefixes to which this rule applies.
Params: - addresses – IP address prefixes in CIDR notation or IP addresses
Returns: the next stage of the definition
/**
* Specifies the traffic source address prefixes to which this rule applies.
* @param addresses IP address prefixes in CIDR notation or IP addresses
* @return the next stage of the definition
*/
WithSourcePort<ParentT> fromAddresses(String... addresses);
Specifies that the rule applies to any traffic source address.
Returns: the next stage of the definition
/**
* Specifies that the rule applies to any traffic source address.
* @return the next stage of the definition
*/
@Method
WithSourcePort<ParentT> fromAnyAddress();
Sets the application security group specified as source.
Params: - id – application security group id
Returns: the next stage of the update
/**
* Sets the application security group specified as source.
* @param id application security group id
* @return the next stage of the update
*/
WithSourcePort<ParentT> withSourceApplicationSecurityGroup(String id);
}
The stage of the network rule definition allowing the source port(s) to be specified.
Type parameters: - <ParentT> – the stage of the parent definition to return to after attaching this definition
/**
* The stage of the network rule definition allowing the source port(s) to be specified.
* @param <ParentT> the stage of the parent definition to return to after attaching this definition
*/
interface WithSourcePort<ParentT> {
Specifies the source port to which this rule applies.
Params: - port – the source port number
Returns: the next stage of the definition
/**
* Specifies the source port to which this rule applies.
* @param port the source port number
* @return the next stage of the definition
*/
WithDestinationAddressOrSecurityGroup<ParentT> fromPort(int port);
Makes this rule apply to any source port.
Returns: the next stage of the definition
/**
* Makes this rule apply to any source port.
* @return the next stage of the definition
*/
@Method
WithDestinationAddressOrSecurityGroup<ParentT> fromAnyPort();
Specifies the source port range to which this rule applies.
Params: - from – the starting port number
- to – the ending port number
Returns: the next stage of the definition
/**
* Specifies the source port range to which this rule applies.
* @param from the starting port number
* @param to the ending port number
* @return the next stage of the definition
*/
WithDestinationAddressOrSecurityGroup<ParentT> fromPortRange(int from, int to);
Specifies the source port ranges to which this rule applies.
Params: - ranges – the starting port ranges
Returns: the next stage of the definition
/**
* Specifies the source port ranges to which this rule applies.
* @param ranges the starting port ranges
* @return the next stage of the definition
*/
WithDestinationAddressOrSecurityGroup<ParentT> fromPortRanges(String... ranges);
}
The stage of the network rule definition allowing the destination address to be specified.
Note: network security rule must specify a non empty value for exactly one of:
DestinationAddressPrefixes, DestinationAddressPrefix, DestinationApplicationSecurityGroups.
Type parameters: - <ParentT> – the stage of the parent definition to return to after attaching this definition
/**
* The stage of the network rule definition allowing the destination address to be specified.
* Note: network security rule must specify a non empty value for exactly one of:
* DestinationAddressPrefixes, DestinationAddressPrefix, DestinationApplicationSecurityGroups.
* @param <ParentT> the stage of the parent definition to return to after attaching this definition
*/
interface WithDestinationAddressOrSecurityGroup<ParentT> {
Specifies the traffic destination address range to which this rule applies.
Params: - cidr – an IP address range expressed in the CIDR notation
Returns: the next stage of the definition
/**
* Specifies the traffic destination address range to which this rule applies.
* @param cidr an IP address range expressed in the CIDR notation
* @return the next stage of the definition
*/
WithDestinationPort<ParentT> toAddress(String cidr);
Specifies the traffic destination address prefixes to which this rule applies.
Params: - addresses – IP address prefixes in CIDR notation or IP addresses
Returns: the next stage of the definition
/**
* Specifies the traffic destination address prefixes to which this rule applies.
* @param addresses IP address prefixes in CIDR notation or IP addresses
* @return the next stage of the definition
*/
@Method
WithDestinationPort<ParentT> toAddresses(String... addresses);
Makes the rule apply to any traffic destination address.
Returns: the next stage of the definition
/**
* Makes the rule apply to any traffic destination address.
* @return the next stage of the definition
*/
@Method
WithDestinationPort<ParentT> toAnyAddress();
Sets the application security group specified as destination.
Params: - id – application security group id
Returns: the next stage of the definition
/**
* Sets the application security group specified as destination.
* @param id application security group id
* @return the next stage of the definition
*/
WithDestinationPort<ParentT> withDestinationApplicationSecurityGroup(String id);
}
The stage of the network rule definition allowing the destination port(s) to be specified.
Type parameters: - <ParentT> – the stage of the parent definition to return to after attaching this definition
/**
* The stage of the network rule definition allowing the destination port(s) to be specified.
* @param <ParentT> the stage of the parent definition to return to after attaching this definition
*/
interface WithDestinationPort<ParentT> {
Specifies the destination port to which this rule applies.
Params: - port – the destination port number
Returns: the next stage of the definition
/**
* Specifies the destination port to which this rule applies.
* @param port the destination port number
* @return the next stage of the definition
*/
WithProtocol<ParentT> toPort(int port);
Makes this rule apply to any destination port.
Returns: the next stage of the definition
/**
* Makes this rule apply to any destination port.
* @return the next stage of the definition
*/
@Method
WithProtocol<ParentT> toAnyPort();
Specifies the destination port range to which this rule applies.
Params: - from – the starting port number
- to – the ending port number
Returns: the next stage of the definition
/**
* Specifies the destination port range to which this rule applies.
* @param from the starting port number
* @param to the ending port number
* @return the next stage of the definition
*/
WithProtocol<ParentT> toPortRange(int from, int to);
Specifies the destination port ranges to which this rule applies.
Params: - ranges – the destination port ranges
Returns: the next stage of the definition
/**
* Specifies the destination port ranges to which this rule applies.
* @param ranges the destination port ranges
* @return the next stage of the definition
*/
WithProtocol<ParentT> toPortRanges(String... ranges);
}
The stage of the security rule definition allowing the protocol that the rule applies to to be specified.
Type parameters: - <ParentT> – the stage of the parent definition to return to after attaching this definition
/**
* The stage of the security rule definition allowing the protocol that the rule applies to to be specified.
* @param <ParentT> the stage of the parent definition to return to after attaching this definition
*/
interface WithProtocol<ParentT> {
Specifies the protocol that this rule applies to.
Params: - protocol – one of the supported protocols
Returns: the next stage of the definition
/**
* Specifies the protocol that this rule applies to.
* @param protocol one of the supported protocols
* @return the next stage of the definition
*/
WithAttach<ParentT> withProtocol(SecurityRuleProtocol protocol);
Makes this rule apply to any supported protocol.
Returns: the next stage of the definition
/**
* Makes this rule apply to any supported protocol.
* @return the next stage of the definition
*/
WithAttach<ParentT> withAnyProtocol();
}
The final stage of the security rule definition.
At this stage, any remaining optional settings can be specified, or the security rule definition can be attached to the parent network security group definition using InUpdate.attach()
.
Type parameters: - <ParentT> – the return type of
InUpdate.attach()
/** The final stage of the security rule definition.
* <p>
* At this stage, any remaining optional settings can be specified, or the security rule definition
* can be attached to the parent network security group definition using {@link WithAttach#attach()}.
* @param <ParentT> the return type of {@link WithAttach#attach()}
*/
interface WithAttach<ParentT> extends Attachable.InUpdate<ParentT> {
Specifies the priority to assign to this rule.
Security rules are applied in the order of their assigned priority.
Params: - priority – the priority number in the range 100 to 4096
Returns: the next stage of the update
/**
* Specifies the priority to assign to this rule.
* <p>
* Security rules are applied in the order of their assigned priority.
* @param priority the priority number in the range 100 to 4096
* @return the next stage of the update
*/
WithAttach<ParentT> withPriority(int priority);
Specifies a description for this security rule.
Params: - descrtiption – a text description to associate with the security rule
Returns: the next stage
/**
* Specifies a description for this security rule.
* @param descrtiption a text description to associate with the security rule
* @return the next stage
*/
WithAttach<ParentT> withDescription(String descrtiption);
}
}
The entirety of a security rule update as part of a network security group update.
/**
* The entirety of a security rule update as part of a network security group update.
*/
interface Update extends
UpdateStages.WithDirectionAccess,
UpdateStages.WithSourceAddressOrSecurityGroup,
UpdateStages.WithSourcePort,
UpdateStages.WithDestinationAddressOrSecurityGroup,
UpdateStages.WithDestinationPort,
UpdateStages.WithProtocol,
Settable<NetworkSecurityGroup.Update> {
Specifies the priority to assign to this security rule.
Security rules are applied in the order of their assigned priority.
Params: - priority – the priority number in the range 100 to 4096
Returns: the next stage of the update
/**
* Specifies the priority to assign to this security rule.
* <p>
* Security rules are applied in the order of their assigned priority.
* @param priority the priority number in the range 100 to 4096
* @return the next stage of the update
*/
Update withPriority(int priority);
Specifies a description for this security rule.
Params: - description – a text description to associate with this security rule
Returns: the next stage
/** Specifies a description for this security rule.
* @param description a text description to associate with this security rule
* @return the next stage
*/
Update withDescription(String description);
}
Grouping of security rule update stages.
/**
* Grouping of security rule update stages.
*/
interface UpdateStages {
The stage of the network rule description allowing the direction and the access type to be specified.
/**
* The stage of the network rule description allowing the direction and the access type to be specified.
*/
interface WithDirectionAccess {
Allows inbound traffic.
Returns: the next stage of the definition
/**
* Allows inbound traffic.
* @return the next stage of the definition
*/
@Method
Update allowInbound();
Allows outbound traffic.
Returns: the next stage of the definition
/**
* Allows outbound traffic.
* @return the next stage of the definition
*/
@Method
Update allowOutbound();
Blocks inbound traffic.
Returns: the next stage of the definition
/**
* Blocks inbound traffic.
* @return the next stage of the definition
*/
@Method
Update denyInbound();
Blocks outbound traffic.
Returns: the next stage of the definition
/**
* Blocks outbound traffic.
* @return the next stage of the definition
*/
@Method
Update denyOutbound();
}
The stage of the network rule description allowing the source address to be specified.
Note: network security rule must specify a non empty value for exactly one of:
SourceAddressPrefixes, SourceAddressPrefix, SourceApplicationSecurityGroups.
/**
* The stage of the network rule description allowing the source address to be specified.
* Note: network security rule must specify a non empty value for exactly one of:
* SourceAddressPrefixes, SourceAddressPrefix, SourceApplicationSecurityGroups.
*/
interface WithSourceAddressOrSecurityGroup {
Specifies the traffic source address prefix to which this rule applies.
Params: - cidr – an IP address prefix expressed in the CIDR notation
Returns: the next stage of the definition
/**
* Specifies the traffic source address prefix to which this rule applies.
* @param cidr an IP address prefix expressed in the CIDR notation
* @return the next stage of the definition
*/
@Method
Update fromAddress(String cidr);
Specifies the traffic source address prefixes to which this rule applies.
Params: - addresses – IP address prefixes in CIDR notation or IP addresses
Returns: the next stage of the definition
/**
* Specifies the traffic source address prefixes to which this rule applies.
* @param addresses IP address prefixes in CIDR notation or IP addresses
* @return the next stage of the definition
*/
Update fromAddresses(String... addresses);
Specifies that the rule applies to any traffic source address.
Returns: the next stage of the definition
/**
* Specifies that the rule applies to any traffic source address.
* @return the next stage of the definition
*/
@Method
Update fromAnyAddress();
Sets the application security group specified as source.
Params: - id – application security group id
Returns: the next stage of the update
/**
* Sets the application security group specified as source.
* @param id application security group id
* @return the next stage of the update
*/
Update withSourceApplicationSecurityGroup(String id);
}
The stage of the network rule description allowing the source port(s) to be specified.
/**
* The stage of the network rule description allowing the source port(s) to be specified.
*/
interface WithSourcePort {
Specifies the source port to which this rule applies.
Params: - port – the source port number
Returns: the next stage of the definition
/**
* Specifies the source port to which this rule applies.
* @param port the source port number
* @return the next stage of the definition
*/
Update fromPort(int port);
Makes this rule apply to any source port.
Returns: the next stage of the definition
/**
* Makes this rule apply to any source port.
* @return the next stage of the definition
*/
@Method
Update fromAnyPort();
Specifies the source port range to which this rule applies.
Params: - from – the starting port number
- to – the ending port number
Returns: the next stage of the definition
/**
* Specifies the source port range to which this rule applies.
* @param from the starting port number
* @param to the ending port number
* @return the next stage of the definition
*/
Update fromPortRange(int from, int to);
Specifies the source port ranges to which this rule applies.
Params: - ranges – the starting port ranges
Returns: the next stage of the definition
/**
* Specifies the source port ranges to which this rule applies.
* @param ranges the starting port ranges
* @return the next stage of the definition
*/
Update fromPortRanges(String... ranges);
}
The stage of the network rule description allowing the destination address to be specified.
Note: network security rule must specify a non empty value for exactly one of:
DestinationAddressPrefixes, DestinationAddressPrefix, DestinationApplicationSecurityGroups.
/**
* The stage of the network rule description allowing the destination address to be specified.
* Note: network security rule must specify a non empty value for exactly one of:
* DestinationAddressPrefixes, DestinationAddressPrefix, DestinationApplicationSecurityGroups.
*/
interface WithDestinationAddressOrSecurityGroup {
Specifies the traffic destination address range to which this rule applies.
Params: - cidr – an IP address range expressed in the CIDR notation
Returns: the next stage of the update
/**
* Specifies the traffic destination address range to which this rule applies.
* @param cidr an IP address range expressed in the CIDR notation
* @return the next stage of the update
*/
Update toAddress(String cidr);
Makes the rule apply to any traffic destination address.
Returns: the next stage of the update
/**
* Makes the rule apply to any traffic destination address.
* @return the next stage of the update
*/
@Method
Update toAnyAddress();
Specifies the traffic destination address prefixes to which this rule applies.
Params: - addresses – IP address prefixes in CIDR notation or IP addresses
Returns: the next stage of the definition
/**
* Specifies the traffic destination address prefixes to which this rule applies.
* @param addresses IP address prefixes in CIDR notation or IP addresses
* @return the next stage of the definition
*/
@Method
Update toAddresses(String... addresses);
Sets the application security group specified as destination.
Params: - id – application security group id
Returns: the next stage of the update
/**
* Sets the application security group specified as destination.
* @param id application security group id
* @return the next stage of the update
*/
Update withDestinationApplicationSecurityGroup(String id);
}
The stage of the network rule description allowing the destination port(s) to be specified.
/**
* The stage of the network rule description allowing the destination port(s) to be specified.
*/
interface WithDestinationPort {
Specifies the destination port to which this rule applies.
Params: - port – the destination port number
Returns: the next stage of the definition
/**
* Specifies the destination port to which this rule applies.
* @param port the destination port number
* @return the next stage of the definition
*/
Update toPort(int port);
Makes this rule apply to any destination port.
Returns: the next stage of the definition
/**
* Makes this rule apply to any destination port.
* @return the next stage of the definition
*/
@Method
Update toAnyPort();
Specifies the destination port range to which this rule applies.
Params: - from – the starting port number
- to – the ending port number
Returns: the next stage of the definition
/**
* Specifies the destination port range to which this rule applies.
* @param from the starting port number
* @param to the ending port number
* @return the next stage of the definition
*/
Update toPortRange(int from, int to);
Specifies the destination port ranges to which this rule applies.
Params: - ranges – the destination port ranges
Returns: the next stage of the definition
/**
* Specifies the destination port ranges to which this rule applies.
* @param ranges the destination port ranges
* @return the next stage of the definition
*/
Update toPortRanges(String... ranges);
}
The stage of the security rule description allowing the protocol that the rule applies to to be specified.
/**
* The stage of the security rule description allowing the protocol that the rule applies to to be specified.
*/
interface WithProtocol {
Specifies the protocol that this rule applies to.
Params: - protocol – one of the supported protocols
Returns: the next stage of the definition
/**
* Specifies the protocol that this rule applies to.
* @param protocol one of the supported protocols
* @return the next stage of the definition
*/
Update withProtocol(SecurityRuleProtocol protocol);
Makes this rule apply to any supported protocol.
Returns: the next stage of the definition
/**
* Makes this rule apply to any supported protocol.
* @return the next stage of the definition
*/
Update withAnyProtocol();
}
}
}