Gets the specified ipGroups.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ipGroups/{ipGroupsName}?api-version=2024-03-01
With optional parameters:
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ipGroups/{ipGroupsName}?api-version=2024-03-01&$expand={$expand}
URI Parameters
Name |
In |
Required |
Type |
Description |
ipGroupsName
|
path |
True
|
string
|
The name of the ipGroups.
|
resourceGroupName
|
path |
True
|
string
|
The name of the resource group.
|
subscriptionId
|
path |
True
|
string
|
The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
|
api-version
|
query |
True
|
string
|
Client API version.
|
$expand
|
query |
|
string
|
Expands resourceIds (of Firewalls/Network Security Groups etc.) back referenced by the IpGroups resource.
|
Responses
Name |
Type |
Description |
200 OK
|
IpGroup
|
Request successful. The operation returns the resulting IpGroups resource.
|
Other Status Codes
|
Error
|
Unexpected error.
|
Security
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name |
Description |
user_impersonation
|
impersonate your user account
|
Examples
Get_IpGroups
Sample request
GET https://management.azure.com/subscriptions/subId/resourceGroups/myResourceGroup/providers/Microsoft.Network/ipGroups/ipGroups1?api-version=2024-03-01
/**
* Samples for IpGroups GetByResourceGroup.
*/
public final class Main {
/*
* x-ms-original-file:
* specification/network/resource-manager/Microsoft.Network/stable/2024-03-01/examples/IpGroupsGet.json
*/
/**
* Sample code: Get_IpGroups.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void getIpGroups(com.azure.resourcemanager.AzureResourceManager azure) {
azure.networks().manager().serviceClient().getIpGroups().getByResourceGroupWithResponse("myResourceGroup",
"ipGroups1", null, com.azure.core.util.Context.NONE);
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.network import NetworkManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-network
# USAGE
python ip_groups_get.py
Before run the sample, please set the values of the client ID, tenant ID and client secret
of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = NetworkManagementClient(
credential=DefaultAzureCredential(),
subscription_id="subId",
)
response = client.ip_groups.get(
resource_group_name="myResourceGroup",
ip_groups_name="ipGroups1",
)
print(response)
# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-03-01/examples/IpGroupsGet.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armnetwork_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v6"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4883fa5dbf6f2c9093fac8ce334547e9dfac68fa/specification/network/resource-manager/Microsoft.Network/stable/2024-03-01/examples/IpGroupsGet.json
func ExampleIPGroupsClient_Get() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewIPGroupsClient().Get(ctx, "myResourceGroup", "ipGroups1", &armnetwork.IPGroupsClientGetOptions{Expand: nil})
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.IPGroup = armnetwork.IPGroup{
// Name: to.Ptr("ipGroups1"),
// Type: to.Ptr("Microsoft.Network/ipGroups"),
// ID: to.Ptr("/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups1"),
// Location: to.Ptr("westcentralus"),
// Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
// Properties: &armnetwork.IPGroupPropertiesFormat{
// FirewallPolicies: []*armnetwork.SubResource{
// },
// Firewalls: []*armnetwork.SubResource{
// {
// ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall"),
// }},
// IPAddresses: []*string{
// to.Ptr("13.64.39.16/32"),
// to.Ptr("40.74.146.80/31"),
// to.Ptr("40.74.147.32/28")},
// ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Gets the specified ipGroups.
*
* @summary Gets the specified ipGroups.
* x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-03-01/examples/IpGroupsGet.json
*/
async function getIPGroups() {
const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subId";
const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "myResourceGroup";
const ipGroupsName = "ipGroups1";
const credential = new DefaultAzureCredential();
const client = new NetworkManagementClient(credential, subscriptionId);
const result = await client.ipGroups.get(resourceGroupName, ipGroupsName);
console.log(result);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Network.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Network;
// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2024-03-01/examples/IpGroupsGet.json
// this example is just showing the usage of "IpGroups_Get" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://zcusa.951200.xyz/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this IPGroupResource created on azure
// for more information of creating IPGroupResource, please refer to the document of IPGroupResource
string subscriptionId = "subId";
string resourceGroupName = "myResourceGroup";
string ipGroupsName = "ipGroups1";
ResourceIdentifier ipGroupResourceId = IPGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, ipGroupsName);
IPGroupResource ipGroup = client.GetIPGroupResource(ipGroupResourceId);
// invoke the operation
IPGroupResource result = await ipGroup.GetAsync();
// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
IPGroupData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Sample response
{
"name": "ipGroups1",
"id": "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups1",
"type": "Microsoft.Network/ipGroups",
"location": "westcentralus",
"properties": {
"provisioningState": "Succeeded",
"ipAddresses": [
"13.64.39.16/32",
"40.74.146.80/31",
"40.74.147.32/28"
],
"firewalls": [
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall"
}
],
"firewallPolicies": []
},
"etag": "w/\\00000000-0000-0000-0000-000000000000\\"
}
Definitions
Error
Common error representation.
Name |
Type |
Description |
code
|
string
|
Error code.
|
details
|
ErrorDetails[]
|
Error details.
|
innerError
|
string
|
Inner error message.
|
message
|
string
|
Error message.
|
target
|
string
|
Error target.
|
ErrorDetails
Common error details representation.
Name |
Type |
Description |
code
|
string
|
Error code.
|
message
|
string
|
Error message.
|
target
|
string
|
Error target.
|
IpGroup
The IpGroups resource information.
Name |
Type |
Description |
etag
|
string
|
A unique read-only string that changes whenever the resource is updated.
|
id
|
string
|
Resource ID.
|
location
|
string
|
Resource location.
|
name
|
string
|
Resource name.
|
properties.firewallPolicies
|
SubResource[]
|
List of references to Firewall Policies resources that this IpGroups is associated with.
|
properties.firewalls
|
SubResource[]
|
List of references to Firewall resources that this IpGroups is associated with.
|
properties.ipAddresses
|
string[]
|
IpAddresses/IpAddressPrefixes in the IpGroups resource.
|
properties.provisioningState
|
ProvisioningState
|
The provisioning state of the IpGroups resource.
|
tags
|
object
|
Resource tags.
|
type
|
string
|
Resource type.
|
ProvisioningState
The current provisioning state.
Name |
Type |
Description |
Deleting
|
string
|
|
Failed
|
string
|
|
Succeeded
|
string
|
|
Updating
|
string
|
|
SubResource
Reference to another subresource.
Name |
Type |
Description |
id
|
string
|
Resource ID.
|