Package com.azure.resourcemanager.search.models

Class NetworkRuleSet

java.lang.Object
com.azure.resourcemanager.search.models.NetworkRuleSet
All Implemented Interfaces:
com.azure.json.JsonSerializable<NetworkRuleSet>
public final class NetworkRuleSet extends Object implements com.azure.json.JsonSerializable<NetworkRuleSet>
Network specific rules that determine how the Azure AI Search service may be reached.

  • Constructor Summary

    Constructors
    Constructor
    Description
    NetworkRuleSet()
    Creates an instance of NetworkRuleSet class.

  • Method Summary

    Modifier and Type
    Method
    Description
    SearchBypass
    bypass()
    Get the bypass property: Possible origins of inbound traffic that can bypass the rules defined in the 'ipRules' section.
    static NetworkRuleSet
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of NetworkRuleSet from the JsonReader.
    List<IpRule>
    ipRules()
    Get the ipRules property: A list of IP restriction rules that defines the inbound network(s) with allowing access to the search service endpoint.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)
    void
    validate()
    Validates the instance.
    NetworkRuleSet
    withBypass(SearchBypass bypass)
    Set the bypass property: Possible origins of inbound traffic that can bypass the rules defined in the 'ipRules' section.
    NetworkRuleSet
    withIpRules(List<IpRule> ipRules)
    Set the ipRules property: A list of IP restriction rules that defines the inbound network(s) with allowing access to the search service endpoint.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString

  • Constructor Details

    • NetworkRuleSet

      public NetworkRuleSet()
      Creates an instance of NetworkRuleSet class.

  • Method Details

    • ipRules

      public List<IpRule> ipRules()
      Get the ipRules property: A list of IP restriction rules that defines the inbound network(s) with allowing access to the search service endpoint. At the meantime, all other public IP networks are blocked by the firewall. These restriction rules are applied only when the 'publicNetworkAccess' of the search service is 'enabled'; otherwise, traffic over public interface is not allowed even with any public IP rules, and private endpoint connections would be the exclusive access method.
      Returns:
      the ipRules value.

    • withIpRules

      public NetworkRuleSet withIpRules(List<IpRule> ipRules)
      Set the ipRules property: A list of IP restriction rules that defines the inbound network(s) with allowing access to the search service endpoint. At the meantime, all other public IP networks are blocked by the firewall. These restriction rules are applied only when the 'publicNetworkAccess' of the search service is 'enabled'; otherwise, traffic over public interface is not allowed even with any public IP rules, and private endpoint connections would be the exclusive access method.
      Parameters:
      ipRules - the ipRules value to set.
      Returns:
      the NetworkRuleSet object itself.

    • bypass

      public SearchBypass bypass()
      Get the bypass property: Possible origins of inbound traffic that can bypass the rules defined in the 'ipRules' section.
      Returns:
      the bypass value.

    • withBypass

      public NetworkRuleSet withBypass(SearchBypass bypass)
      Set the bypass property: Possible origins of inbound traffic that can bypass the rules defined in the 'ipRules' section.
      Parameters:
      bypass - the bypass value to set.
      Returns:
      the NetworkRuleSet object itself.

    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<NetworkRuleSet>
      Throws:
      IOException

    • fromJson

      public static NetworkRuleSet fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of NetworkRuleSet from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of NetworkRuleSet if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IOException - If an error occurs while reading the NetworkRuleSet.