### YamlMime:JavaType
uid: "com.azure.resourcemanager.network.models.AdminRule"
fullName: "com.azure.resourcemanager.network.models.AdminRule"
name: "AdminRule"
nameWithType: "AdminRule"
summary: "Network admin rule."
inheritances:
- ""
- ""
- ""
- ""
inheritedClassMethods:
- classRef: ""
methodsRef:
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- classRef: "java.lang.Object"
methodsRef:
- "clone"
- "equals"
- "finalize"
- "getClass"
- "hashCode"
- "notify"
- "notifyAll"
- "toString"
- "wait"
- "wait"
- "wait"
syntax: "public final class **AdminRule** extends "
constructors:
- uid: "com.azure.resourcemanager.network.models.AdminRule.AdminRule()"
fullName: "com.azure.resourcemanager.network.models.AdminRule.AdminRule()"
name: "AdminRule()"
nameWithType: "AdminRule.AdminRule()"
summary: "Creates an instance of AdminRule class."
syntax: "public AdminRule()"
desc: "Creates an instance of AdminRule class."
methods:
- uid: "com.azure.resourcemanager.network.models.AdminRule.access()"
fullName: "com.azure.resourcemanager.network.models.AdminRule.access()"
name: "access()"
nameWithType: "AdminRule.access()"
summary: "Get the access property: Indicates the access allowed for this particular rule."
syntax: "public SecurityConfigurationRuleAccess access()"
desc: "Get the access property: Indicates the access allowed for this particular rule."
returns:
description: "the access value."
type: ""
- uid: "com.azure.resourcemanager.network.models.AdminRule.description()"
fullName: "com.azure.resourcemanager.network.models.AdminRule.description()"
name: "description()"
nameWithType: "AdminRule.description()"
summary: "Get the description property: A description for this rule."
syntax: "public String description()"
desc: "Get the description property: A description for this rule. Restricted to 140 chars."
returns:
description: "the description value."
type: "String"
- uid: "com.azure.resourcemanager.network.models.AdminRule.destinationPortRanges()"
fullName: "com.azure.resourcemanager.network.models.AdminRule.destinationPortRanges()"
name: "destinationPortRanges()"
nameWithType: "AdminRule.destinationPortRanges()"
summary: "Get the destinationPortRanges property: The destination port ranges."
syntax: "public List destinationPortRanges()"
desc: "Get the destinationPortRanges property: The destination port ranges."
returns:
description: "the destinationPortRanges value."
type: "List<String>"
- uid: "com.azure.resourcemanager.network.models.AdminRule.destinations()"
fullName: "com.azure.resourcemanager.network.models.AdminRule.destinations()"
name: "destinations()"
nameWithType: "AdminRule.destinations()"
summary: "Get the destinations property: The destination address prefixes."
syntax: "public List destinations()"
desc: "Get the destinations property: The destination address prefixes. CIDR or destination IP ranges."
returns:
description: "the destinations value."
type: "List<>"
- uid: "com.azure.resourcemanager.network.models.AdminRule.direction()"
fullName: "com.azure.resourcemanager.network.models.AdminRule.direction()"
name: "direction()"
nameWithType: "AdminRule.direction()"
summary: "Get the direction property: Indicates if the traffic matched against the rule in inbound or outbound."
syntax: "public SecurityConfigurationRuleDirection direction()"
desc: "Get the direction property: Indicates if the traffic matched against the rule in inbound or outbound."
returns:
description: "the direction value."
type: ""
- uid: "com.azure.resourcemanager.network.models.AdminRule.etag()"
fullName: "com.azure.resourcemanager.network.models.AdminRule.etag()"
name: "etag()"
nameWithType: "AdminRule.etag()"
summary: "Get the etag property: A unique read-only string that changes whenever the resource is updated."
overridden: "com.azure.resourcemanager.network.fluent.models.BaseAdminRuleInner.etag()"
syntax: "public String etag()"
desc: "Get the etag property: A unique read-only string that changes whenever the resource is updated."
returns:
description: "the etag value."
type: "String"
- uid: "com.azure.resourcemanager.network.models.AdminRule.fromJson(com.azure.json.JsonReader)"
fullName: "com.azure.resourcemanager.network.models.AdminRule.fromJson(JsonReader jsonReader)"
name: "fromJson(JsonReader jsonReader)"
nameWithType: "AdminRule.fromJson(JsonReader jsonReader)"
summary: "Reads an instance of AdminRule from the JsonReader."
modifiers:
- "static"
parameters:
- description: "The JsonReader being read."
name: "jsonReader"
type: ""
syntax: "public static AdminRule fromJson(JsonReader jsonReader)"
exceptions:
- description: "If the deserialized JSON object was missing any required properties."
type: "IOException"
desc: "Reads an instance of AdminRule from the JsonReader."
returns:
description: "An instance of AdminRule if the JsonReader was pointing to an instance of it, or null if it was pointing\n to JSON null."
type: ""
- uid: "com.azure.resourcemanager.network.models.AdminRule.id()"
fullName: "com.azure.resourcemanager.network.models.AdminRule.id()"
name: "id()"
nameWithType: "AdminRule.id()"
summary: "Get the id property: Fully qualified resource Id for the resource."
overridden: "com.azure.resourcemanager.network.fluent.models.BaseAdminRuleInner.id()"
syntax: "public String id()"
desc: "Get the id property: Fully qualified resource Id for the resource."
returns:
description: "the id value."
type: "String"
- uid: "com.azure.resourcemanager.network.models.AdminRule.kind()"
fullName: "com.azure.resourcemanager.network.models.AdminRule.kind()"
name: "kind()"
nameWithType: "AdminRule.kind()"
summary: "Get the kind property: Whether the rule is custom or default."
overridden: "com.azure.resourcemanager.network.fluent.models.BaseAdminRuleInner.kind()"
syntax: "public AdminRuleKind kind()"
desc: "Get the kind property: Whether the rule is custom or default."
returns:
description: "the kind value."
type: ""
- uid: "com.azure.resourcemanager.network.models.AdminRule.name()"
fullName: "com.azure.resourcemanager.network.models.AdminRule.name()"
name: "name()"
nameWithType: "AdminRule.name()"
summary: "Get the name property: The name of the resource."
overridden: "com.azure.resourcemanager.network.fluent.models.BaseAdminRuleInner.name()"
syntax: "public String name()"
desc: "Get the name property: The name of the resource."
returns:
description: "the name value."
type: "String"
- uid: "com.azure.resourcemanager.network.models.AdminRule.priority()"
fullName: "com.azure.resourcemanager.network.models.AdminRule.priority()"
name: "priority()"
nameWithType: "AdminRule.priority()"
summary: "Get the priority property: The priority of the rule."
syntax: "public Integer priority()"
desc: "Get the priority property: The priority of the rule. The value can be between 1 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule."
returns:
description: "the priority value."
type: "Integer"
- uid: "com.azure.resourcemanager.network.models.AdminRule.protocol()"
fullName: "com.azure.resourcemanager.network.models.AdminRule.protocol()"
name: "protocol()"
nameWithType: "AdminRule.protocol()"
summary: "Get the protocol property: Network protocol this rule applies to."
syntax: "public SecurityConfigurationRuleProtocol protocol()"
desc: "Get the protocol property: Network protocol this rule applies to."
returns:
description: "the protocol value."
type: ""
- uid: "com.azure.resourcemanager.network.models.AdminRule.provisioningState()"
fullName: "com.azure.resourcemanager.network.models.AdminRule.provisioningState()"
name: "provisioningState()"
nameWithType: "AdminRule.provisioningState()"
summary: "Get the provisioningState property: The provisioning state of the resource."
syntax: "public ProvisioningState provisioningState()"
desc: "Get the provisioningState property: The provisioning state of the resource."
returns:
description: "the provisioningState value."
type: ""
- uid: "com.azure.resourcemanager.network.models.AdminRule.resourceGuid()"
fullName: "com.azure.resourcemanager.network.models.AdminRule.resourceGuid()"
name: "resourceGuid()"
nameWithType: "AdminRule.resourceGuid()"
summary: "Get the resourceGuid property: Unique identifier for this resource."
syntax: "public String resourceGuid()"
desc: "Get the resourceGuid property: Unique identifier for this resource."
returns:
description: "the resourceGuid value."
type: "String"
- uid: "com.azure.resourcemanager.network.models.AdminRule.sourcePortRanges()"
fullName: "com.azure.resourcemanager.network.models.AdminRule.sourcePortRanges()"
name: "sourcePortRanges()"
nameWithType: "AdminRule.sourcePortRanges()"
summary: "Get the sourcePortRanges property: The source port ranges."
syntax: "public List sourcePortRanges()"
desc: "Get the sourcePortRanges property: The source port ranges."
returns:
description: "the sourcePortRanges value."
type: "List<String>"
- uid: "com.azure.resourcemanager.network.models.AdminRule.sources()"
fullName: "com.azure.resourcemanager.network.models.AdminRule.sources()"
name: "sources()"
nameWithType: "AdminRule.sources()"
summary: "Get the sources property: The CIDR or source IP ranges."
syntax: "public List sources()"
desc: "Get the sources property: The CIDR or source IP ranges."
returns:
description: "the sources value."
type: "List<>"
- uid: "com.azure.resourcemanager.network.models.AdminRule.systemData()"
fullName: "com.azure.resourcemanager.network.models.AdminRule.systemData()"
name: "systemData()"
nameWithType: "AdminRule.systemData()"
summary: "Get the systemData property: The system metadata related to this resource."
overridden: "com.azure.resourcemanager.network.fluent.models.BaseAdminRuleInner.systemData()"
syntax: "public SystemData systemData()"
desc: "Get the systemData property: The system metadata related to this resource."
returns:
description: "the systemData value."
type: ""
- uid: "com.azure.resourcemanager.network.models.AdminRule.toJson(com.azure.json.JsonWriter)"
fullName: "com.azure.resourcemanager.network.models.AdminRule.toJson(JsonWriter jsonWriter)"
name: "toJson(JsonWriter jsonWriter)"
nameWithType: "AdminRule.toJson(JsonWriter jsonWriter)"
overridden: "com.azure.resourcemanager.network.fluent.models.BaseAdminRuleInner.toJson(com.azure.json.JsonWriter)"
parameters:
- name: "jsonWriter"
type: ""
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
exceptions:
- type: "IOException"
returns:
type: ""
- uid: "com.azure.resourcemanager.network.models.AdminRule.type()"
fullName: "com.azure.resourcemanager.network.models.AdminRule.type()"
name: "type()"
nameWithType: "AdminRule.type()"
summary: "Get the type property: The type of the resource."
overridden: "com.azure.resourcemanager.network.fluent.models.BaseAdminRuleInner.type()"
syntax: "public String type()"
desc: "Get the type property: The type of the resource."
returns:
description: "the type value."
type: "String"
- uid: "com.azure.resourcemanager.network.models.AdminRule.validate()"
fullName: "com.azure.resourcemanager.network.models.AdminRule.validate()"
name: "validate()"
nameWithType: "AdminRule.validate()"
summary: "Validates the instance."
overridden: "com.azure.resourcemanager.network.fluent.models.BaseAdminRuleInner.validate()"
syntax: "public void validate()"
desc: "Validates the instance."
- uid: "com.azure.resourcemanager.network.models.AdminRule.withAccess(com.azure.resourcemanager.network.models.SecurityConfigurationRuleAccess)"
fullName: "com.azure.resourcemanager.network.models.AdminRule.withAccess(SecurityConfigurationRuleAccess access)"
name: "withAccess(SecurityConfigurationRuleAccess access)"
nameWithType: "AdminRule.withAccess(SecurityConfigurationRuleAccess access)"
summary: "Set the access property: Indicates the access allowed for this particular rule."
parameters:
- description: "the access value to set."
name: "access"
type: ""
syntax: "public AdminRule withAccess(SecurityConfigurationRuleAccess access)"
desc: "Set the access property: Indicates the access allowed for this particular rule."
returns:
description: "the AdminRule object itself."
type: ""
- uid: "com.azure.resourcemanager.network.models.AdminRule.withDescription(java.lang.String)"
fullName: "com.azure.resourcemanager.network.models.AdminRule.withDescription(String description)"
name: "withDescription(String description)"
nameWithType: "AdminRule.withDescription(String description)"
summary: "Set the description property: A description for this rule."
parameters:
- description: "the description value to set."
name: "description"
type: "String"
syntax: "public AdminRule withDescription(String description)"
desc: "Set the description property: A description for this rule. Restricted to 140 chars."
returns:
description: "the AdminRule object itself."
type: ""
- uid: "com.azure.resourcemanager.network.models.AdminRule.withDestinationPortRanges(java.util.List)"
fullName: "com.azure.resourcemanager.network.models.AdminRule.withDestinationPortRanges(List destinationPortRanges)"
name: "withDestinationPortRanges(List destinationPortRanges)"
nameWithType: "AdminRule.withDestinationPortRanges(List destinationPortRanges)"
summary: "Set the destinationPortRanges property: The destination port ranges."
parameters:
- description: "the destinationPortRanges value to set."
name: "destinationPortRanges"
type: "List<String>"
syntax: "public AdminRule withDestinationPortRanges(List destinationPortRanges)"
desc: "Set the destinationPortRanges property: The destination port ranges."
returns:
description: "the AdminRule object itself."
type: ""
- uid: "com.azure.resourcemanager.network.models.AdminRule.withDestinations(java.util.List)"
fullName: "com.azure.resourcemanager.network.models.AdminRule.withDestinations(List destinations)"
name: "withDestinations(List destinations)"
nameWithType: "AdminRule.withDestinations(List destinations)"
summary: "Set the destinations property: The destination address prefixes."
parameters:
- description: "the destinations value to set."
name: "destinations"
type: "List<>"
syntax: "public AdminRule withDestinations(List destinations)"
desc: "Set the destinations property: The destination address prefixes. CIDR or destination IP ranges."
returns:
description: "the AdminRule object itself."
type: ""
- uid: "com.azure.resourcemanager.network.models.AdminRule.withDirection(com.azure.resourcemanager.network.models.SecurityConfigurationRuleDirection)"
fullName: "com.azure.resourcemanager.network.models.AdminRule.withDirection(SecurityConfigurationRuleDirection direction)"
name: "withDirection(SecurityConfigurationRuleDirection direction)"
nameWithType: "AdminRule.withDirection(SecurityConfigurationRuleDirection direction)"
summary: "Set the direction property: Indicates if the traffic matched against the rule in inbound or outbound."
parameters:
- description: "the direction value to set."
name: "direction"
type: ""
syntax: "public AdminRule withDirection(SecurityConfigurationRuleDirection direction)"
desc: "Set the direction property: Indicates if the traffic matched against the rule in inbound or outbound."
returns:
description: "the AdminRule object itself."
type: ""
- uid: "com.azure.resourcemanager.network.models.AdminRule.withPriority(java.lang.Integer)"
fullName: "com.azure.resourcemanager.network.models.AdminRule.withPriority(Integer priority)"
name: "withPriority(Integer priority)"
nameWithType: "AdminRule.withPriority(Integer priority)"
summary: "Set the priority property: The priority of the rule."
parameters:
- description: "the priority value to set."
name: "priority"
type: "Integer"
syntax: "public AdminRule withPriority(Integer priority)"
desc: "Set the priority property: The priority of the rule. The value can be between 1 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule."
returns:
description: "the AdminRule object itself."
type: ""
- uid: "com.azure.resourcemanager.network.models.AdminRule.withProtocol(com.azure.resourcemanager.network.models.SecurityConfigurationRuleProtocol)"
fullName: "com.azure.resourcemanager.network.models.AdminRule.withProtocol(SecurityConfigurationRuleProtocol protocol)"
name: "withProtocol(SecurityConfigurationRuleProtocol protocol)"
nameWithType: "AdminRule.withProtocol(SecurityConfigurationRuleProtocol protocol)"
summary: "Set the protocol property: Network protocol this rule applies to."
parameters:
- description: "the protocol value to set."
name: "protocol"
type: ""
syntax: "public AdminRule withProtocol(SecurityConfigurationRuleProtocol protocol)"
desc: "Set the protocol property: Network protocol this rule applies to."
returns:
description: "the AdminRule object itself."
type: ""
- uid: "com.azure.resourcemanager.network.models.AdminRule.withSourcePortRanges(java.util.List)"
fullName: "com.azure.resourcemanager.network.models.AdminRule.withSourcePortRanges(List sourcePortRanges)"
name: "withSourcePortRanges(List sourcePortRanges)"
nameWithType: "AdminRule.withSourcePortRanges(List sourcePortRanges)"
summary: "Set the sourcePortRanges property: The source port ranges."
parameters:
- description: "the sourcePortRanges value to set."
name: "sourcePortRanges"
type: "List<String>"
syntax: "public AdminRule withSourcePortRanges(List sourcePortRanges)"
desc: "Set the sourcePortRanges property: The source port ranges."
returns:
description: "the AdminRule object itself."
type: ""
- uid: "com.azure.resourcemanager.network.models.AdminRule.withSources(java.util.List)"
fullName: "com.azure.resourcemanager.network.models.AdminRule.withSources(List sources)"
name: "withSources(List sources)"
nameWithType: "AdminRule.withSources(List sources)"
summary: "Set the sources property: The CIDR or source IP ranges."
parameters:
- description: "the sources value to set."
name: "sources"
type: "List<>"
syntax: "public AdminRule withSources(List sources)"
desc: "Set the sources property: The CIDR or source IP ranges."
returns:
description: "the AdminRule object itself."
type: ""
type: "class"
desc: "Network admin rule."
metadata: {}
package: "com.azure.resourcemanager.network.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-network:2.44.0