1. Packages
  2. Azure Native
  3. API Docs
  4. sql
  5. getVirtualNetworkRule
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi

azure-native.sql.getVirtualNetworkRule

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi

    Gets a virtual network rule.

    Uses Azure REST API version 2023-08-01.

    Other available API versions: 2015-05-01-preview, 2020-02-02-preview, 2020-08-01-preview, 2020-11-01-preview, 2021-02-01-preview, 2021-05-01-preview, 2021-08-01-preview, 2021-11-01, 2021-11-01-preview, 2022-02-01-preview, 2022-05-01-preview, 2022-08-01-preview, 2022-11-01-preview, 2023-02-01-preview, 2023-05-01-preview, 2023-08-01-preview, 2024-05-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native sql [ApiVersion]. See the version guide for details.

    Using getVirtualNetworkRule

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getVirtualNetworkRule(args: GetVirtualNetworkRuleArgs, opts?: InvokeOptions): Promise<GetVirtualNetworkRuleResult>
    function getVirtualNetworkRuleOutput(args: GetVirtualNetworkRuleOutputArgs, opts?: InvokeOptions): Output<GetVirtualNetworkRuleResult>
    def get_virtual_network_rule(resource_group_name: Optional[str] = None,
                                 server_name: Optional[str] = None,
                                 virtual_network_rule_name: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetVirtualNetworkRuleResult
    def get_virtual_network_rule_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                                 server_name: Optional[pulumi.Input[str]] = None,
                                 virtual_network_rule_name: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetVirtualNetworkRuleResult]
    func LookupVirtualNetworkRule(ctx *Context, args *LookupVirtualNetworkRuleArgs, opts ...InvokeOption) (*LookupVirtualNetworkRuleResult, error)
    func LookupVirtualNetworkRuleOutput(ctx *Context, args *LookupVirtualNetworkRuleOutputArgs, opts ...InvokeOption) LookupVirtualNetworkRuleResultOutput

    > Note: This function is named LookupVirtualNetworkRule in the Go SDK.

    public static class GetVirtualNetworkRule 
    {
        public static Task<GetVirtualNetworkRuleResult> InvokeAsync(GetVirtualNetworkRuleArgs args, InvokeOptions? opts = null)
        public static Output<GetVirtualNetworkRuleResult> Invoke(GetVirtualNetworkRuleInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetVirtualNetworkRuleResult> getVirtualNetworkRule(GetVirtualNetworkRuleArgs args, InvokeOptions options)
    public static Output<GetVirtualNetworkRuleResult> getVirtualNetworkRule(GetVirtualNetworkRuleArgs args, InvokeOptions options)
    
    fn::invoke:
      function: azure-native:sql:getVirtualNetworkRule
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ResourceGroupName string
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    ServerName string
    The name of the server.
    VirtualNetworkRuleName string
    The name of the virtual network rule.
    ResourceGroupName string
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    ServerName string
    The name of the server.
    VirtualNetworkRuleName string
    The name of the virtual network rule.
    resourceGroupName String
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    serverName String
    The name of the server.
    virtualNetworkRuleName String
    The name of the virtual network rule.
    resourceGroupName string
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    serverName string
    The name of the server.
    virtualNetworkRuleName string
    The name of the virtual network rule.
    resource_group_name str
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    server_name str
    The name of the server.
    virtual_network_rule_name str
    The name of the virtual network rule.
    resourceGroupName String
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    serverName String
    The name of the server.
    virtualNetworkRuleName String
    The name of the virtual network rule.

    getVirtualNetworkRule Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Resource ID.
    Name string
    Resource name.
    State string
    Virtual Network Rule State
    Type string
    Resource type.
    VirtualNetworkSubnetId string
    The ARM resource id of the virtual network subnet.
    IgnoreMissingVnetServiceEndpoint bool
    Create firewall rule before the virtual network has vnet service endpoint enabled.
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Resource ID.
    Name string
    Resource name.
    State string
    Virtual Network Rule State
    Type string
    Resource type.
    VirtualNetworkSubnetId string
    The ARM resource id of the virtual network subnet.
    IgnoreMissingVnetServiceEndpoint bool
    Create firewall rule before the virtual network has vnet service endpoint enabled.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Resource ID.
    name String
    Resource name.
    state String
    Virtual Network Rule State
    type String
    Resource type.
    virtualNetworkSubnetId String
    The ARM resource id of the virtual network subnet.
    ignoreMissingVnetServiceEndpoint Boolean
    Create firewall rule before the virtual network has vnet service endpoint enabled.
    azureApiVersion string
    The Azure API version of the resource.
    id string
    Resource ID.
    name string
    Resource name.
    state string
    Virtual Network Rule State
    type string
    Resource type.
    virtualNetworkSubnetId string
    The ARM resource id of the virtual network subnet.
    ignoreMissingVnetServiceEndpoint boolean
    Create firewall rule before the virtual network has vnet service endpoint enabled.
    azure_api_version str
    The Azure API version of the resource.
    id str
    Resource ID.
    name str
    Resource name.
    state str
    Virtual Network Rule State
    type str
    Resource type.
    virtual_network_subnet_id str
    The ARM resource id of the virtual network subnet.
    ignore_missing_vnet_service_endpoint bool
    Create firewall rule before the virtual network has vnet service endpoint enabled.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Resource ID.
    name String
    Resource name.
    state String
    Virtual Network Rule State
    type String
    Resource type.
    virtualNetworkSubnetId String
    The ARM resource id of the virtual network subnet.
    ignoreMissingVnetServiceEndpoint Boolean
    Create firewall rule before the virtual network has vnet service endpoint enabled.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi