1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. getIpGroup
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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

azure-native.network.getIpGroup

Explore with Pulumi AI

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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

Gets the specified ipGroups.

Uses Azure REST API version 2024-05-01.

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

Using getIpGroup

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 getIpGroup(args: GetIpGroupArgs, opts?: InvokeOptions): Promise<GetIpGroupResult>
function getIpGroupOutput(args: GetIpGroupOutputArgs, opts?: InvokeOptions): Output<GetIpGroupResult>
Copy
def get_ip_group(expand: Optional[str] = None,
                 ip_groups_name: Optional[str] = None,
                 resource_group_name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetIpGroupResult
def get_ip_group_output(expand: Optional[pulumi.Input[str]] = None,
                 ip_groups_name: Optional[pulumi.Input[str]] = None,
                 resource_group_name: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetIpGroupResult]
Copy
func LookupIpGroup(ctx *Context, args *LookupIpGroupArgs, opts ...InvokeOption) (*LookupIpGroupResult, error)
func LookupIpGroupOutput(ctx *Context, args *LookupIpGroupOutputArgs, opts ...InvokeOption) LookupIpGroupResultOutput
Copy

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

public static class GetIpGroup 
{
    public static Task<GetIpGroupResult> InvokeAsync(GetIpGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetIpGroupResult> Invoke(GetIpGroupInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetIpGroupResult> getIpGroup(GetIpGroupArgs args, InvokeOptions options)
public static Output<GetIpGroupResult> getIpGroup(GetIpGroupArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:network:getIpGroup
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

IpGroupsName
This property is required.
Changes to this property will trigger replacement.
string
The name of the ipGroups.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
Expand string
Expands resourceIds (of Firewalls/Network Security Groups etc.) back referenced by the IpGroups resource.
IpGroupsName
This property is required.
Changes to this property will trigger replacement.
string
The name of the ipGroups.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
Expand string
Expands resourceIds (of Firewalls/Network Security Groups etc.) back referenced by the IpGroups resource.
ipGroupsName
This property is required.
Changes to this property will trigger replacement.
String
The name of the ipGroups.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
expand String
Expands resourceIds (of Firewalls/Network Security Groups etc.) back referenced by the IpGroups resource.
ipGroupsName
This property is required.
Changes to this property will trigger replacement.
string
The name of the ipGroups.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
expand string
Expands resourceIds (of Firewalls/Network Security Groups etc.) back referenced by the IpGroups resource.
ip_groups_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the ipGroups.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
expand str
Expands resourceIds (of Firewalls/Network Security Groups etc.) back referenced by the IpGroups resource.
ipGroupsName
This property is required.
Changes to this property will trigger replacement.
String
The name of the ipGroups.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
expand String
Expands resourceIds (of Firewalls/Network Security Groups etc.) back referenced by the IpGroups resource.

getIpGroup Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Etag string
A unique read-only string that changes whenever the resource is updated.
FirewallPolicies List<Pulumi.AzureNative.Network.Outputs.SubResourceResponse>
List of references to Firewall Policies resources that this IpGroups is associated with.
Firewalls List<Pulumi.AzureNative.Network.Outputs.SubResourceResponse>
List of references to Firewall resources that this IpGroups is associated with.
Name string
Resource name.
ProvisioningState string
The provisioning state of the IpGroups resource.
Type string
Resource type.
Id string
Resource ID.
IpAddresses List<string>
IpAddresses/IpAddressPrefixes in the IpGroups resource.
Location string
Resource location.
Tags Dictionary<string, string>
Resource tags.
AzureApiVersion string
The Azure API version of the resource.
Etag string
A unique read-only string that changes whenever the resource is updated.
FirewallPolicies []SubResourceResponse
List of references to Firewall Policies resources that this IpGroups is associated with.
Firewalls []SubResourceResponse
List of references to Firewall resources that this IpGroups is associated with.
Name string
Resource name.
ProvisioningState string
The provisioning state of the IpGroups resource.
Type string
Resource type.
Id string
Resource ID.
IpAddresses []string
IpAddresses/IpAddressPrefixes in the IpGroups resource.
Location string
Resource location.
Tags map[string]string
Resource tags.
azureApiVersion String
The Azure API version of the resource.
etag String
A unique read-only string that changes whenever the resource is updated.
firewallPolicies List<SubResourceResponse>
List of references to Firewall Policies resources that this IpGroups is associated with.
firewalls List<SubResourceResponse>
List of references to Firewall resources that this IpGroups is associated with.
name String
Resource name.
provisioningState String
The provisioning state of the IpGroups resource.
type String
Resource type.
id String
Resource ID.
ipAddresses List<String>
IpAddresses/IpAddressPrefixes in the IpGroups resource.
location String
Resource location.
tags Map<String,String>
Resource tags.
azureApiVersion string
The Azure API version of the resource.
etag string
A unique read-only string that changes whenever the resource is updated.
firewallPolicies SubResourceResponse[]
List of references to Firewall Policies resources that this IpGroups is associated with.
firewalls SubResourceResponse[]
List of references to Firewall resources that this IpGroups is associated with.
name string
Resource name.
provisioningState string
The provisioning state of the IpGroups resource.
type string
Resource type.
id string
Resource ID.
ipAddresses string[]
IpAddresses/IpAddressPrefixes in the IpGroups resource.
location string
Resource location.
tags {[key: string]: string}
Resource tags.
azure_api_version str
The Azure API version of the resource.
etag str
A unique read-only string that changes whenever the resource is updated.
firewall_policies Sequence[SubResourceResponse]
List of references to Firewall Policies resources that this IpGroups is associated with.
firewalls Sequence[SubResourceResponse]
List of references to Firewall resources that this IpGroups is associated with.
name str
Resource name.
provisioning_state str
The provisioning state of the IpGroups resource.
type str
Resource type.
id str
Resource ID.
ip_addresses Sequence[str]
IpAddresses/IpAddressPrefixes in the IpGroups resource.
location str
Resource location.
tags Mapping[str, str]
Resource tags.
azureApiVersion String
The Azure API version of the resource.
etag String
A unique read-only string that changes whenever the resource is updated.
firewallPolicies List<Property Map>
List of references to Firewall Policies resources that this IpGroups is associated with.
firewalls List<Property Map>
List of references to Firewall resources that this IpGroups is associated with.
name String
Resource name.
provisioningState String
The provisioning state of the IpGroups resource.
type String
Resource type.
id String
Resource ID.
ipAddresses List<String>
IpAddresses/IpAddressPrefixes in the IpGroups resource.
location String
Resource location.
tags Map<String>
Resource tags.

Supporting Types

SubResourceResponse

Id string
Resource ID.
Id string
Resource ID.
id String
Resource ID.
id string
Resource ID.
id str
Resource ID.
id String
Resource ID.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi