NetApp Resource - Query Network Sibling Set

Referens

Service:: Azure NetApp Files

API Version:: 2023-07-01

Beskriva en nätverkskonsyskonuppsättning
Hämta information om den angivna nätverkskonsyskonuppsättningen.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/queryNetworkSiblingSet?api-version=2023-07-01

URI-parametrar

Name	I	Obligatorisk	Typ	Description
location	path	True	string	Namnet på Azure-regionen.
subscriptionId	path	True	string uuid	ID för målprenumerationen. Värdet måste vara ett UUID.
api-version	query	True	string	Den API-version som ska användas för den här åtgärden.

Begärandetext

Name	Obligatorisk	Typ	Description
networkSiblingSetId	True	string	Nätverkskonsyskonuppsättnings-ID Nätverkskonsyskonuppsättnings-ID för en grupp volymer som delar nätverksresurser i ett undernät.
subnetId	True	string	Resurs-ID för undernätet Azure Resource URI för ett delegerat undernät. Måste ha delegeringen Microsoft.NetApp/volumes. Exempel /subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.Network/virtualNetworks/testVnet/subnets/{mySubnet}

Svar

Name	Typ	Description
200 OK	networkSiblingSet	OK
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

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	personifiera ditt användarkonto

Exempel

NetworkSiblingSet_Query

Sample Request

POST https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/queryNetworkSiblingSet?api-version=2023-07-01

{
  "networkSiblingSetId": "9760acf5-4638-11e7-9bdb-020073ca3333",
  "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testVnet/subnets/testSubnet"
}


import com.azure.resourcemanager.netapp.models.QueryNetworkSiblingSetRequest;

/**
 * Samples for NetAppResource QueryNetworkSiblingSet.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/NetworkSiblingSet_Query.json
     */
    /**
     * Sample code: NetworkSiblingSet_Query.
     * 
     * @param manager Entry point to NetAppFilesManager.
     */
    public static void networkSiblingSetQuery(com.azure.resourcemanager.netapp.NetAppFilesManager manager) {
        manager.netAppResources().queryNetworkSiblingSetWithResponse("eastus", new QueryNetworkSiblingSetRequest()
            .withNetworkSiblingSetId("9760acf5-4638-11e7-9bdb-020073ca3333").withSubnetId(
                "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testVnet/subnets/testSubnet"),
            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

package armnetapp_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/netapp/armnetapp/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/cf5ad1932d00c7d15497705ad6b71171d3d68b1e/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/NetworkSiblingSet_Query.json
func ExampleResourceClient_QueryNetworkSiblingSet() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetapp.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewResourceClient().QueryNetworkSiblingSet(ctx, "eastus", armnetapp.QueryNetworkSiblingSetRequest{
		NetworkSiblingSetID: to.Ptr("9760acf5-4638-11e7-9bdb-020073ca3333"),
		SubnetID:            to.Ptr("/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testVnet/subnets/testSubnet"),
	}, 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.NetworkSiblingSet = armnetapp.NetworkSiblingSet{
	// 	NetworkFeatures: to.Ptr(armnetapp.NetworkFeaturesStandard),
	// 	NetworkSiblingSetID: to.Ptr("9760acf5-4638-11e7-9bdb-020073ca3333"),
	// 	NetworkSiblingSetStateID: to.Ptr("12345_44420.8001578125"),
	// 	NicInfoList: []*armnetapp.NicInfo{
	// 		{
	// 			IPAddress: to.Ptr("1.2.3.4"),
	// 			VolumeResourceIDs: []*string{
	// 				to.Ptr("/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume10"),
	// 				to.Ptr("/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume11")},
	// 			},
	// 			{
	// 				IPAddress: to.Ptr("1.2.3.5"),
	// 				VolumeResourceIDs: []*string{
	// 					to.Ptr("/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account2/capacityPools/pool2/volumes/volume20"),
	// 					to.Ptr("/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account2/capacityPools/pool2/volumes/volume21")},
	// 				},
	// 				{
	// 					IPAddress: to.Ptr("1.2.3.9"),
	// 					VolumeResourceIDs: []*string{
	// 					},
	// 			}},
	// 			ProvisioningState: to.Ptr(armnetapp.NetworkSiblingSetProvisioningStateSucceeded),
	// 			SubnetID: to.Ptr("/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testVnet/subnets/testSubnet"),
	// 		}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { NetAppManagementClient } = require("@azure/arm-netapp");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Get details of the specified network sibling set.
 *
 * @summary Get details of the specified network sibling set.
 * x-ms-original-file: specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/NetworkSiblingSet_Query.json
 */
async function networkSiblingSetQuery() {
  const subscriptionId =
    process.env["NETAPP_SUBSCRIPTION_ID"] || "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9";
  const location = "eastus";
  const networkSiblingSetId = "9760acf5-4638-11e7-9bdb-020073ca3333";
  const subnetId =
    "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testVnet/subnets/testSubnet";
  const credential = new DefaultAzureCredential();
  const client = new NetAppManagementClient(credential, subscriptionId);
  const result = await client.netAppResource.queryNetworkSiblingSet(
    location,
    networkSiblingSetId,
    subnetId,
  );
  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 System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.NetApp;
using Azure.ResourceManager.NetApp.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/NetworkSiblingSet_Query.json
// this example is just showing the usage of "NetAppResource_QueryNetworkSiblingSet" 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://learn.microsoft.com/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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation
AzureLocation location = new AzureLocation("eastus");
QueryNetworkSiblingSetContent content = new QueryNetworkSiblingSetContent("9760acf5-4638-11e7-9bdb-020073ca3333", new ResourceIdentifier("/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testVnet/subnets/testSubnet"));
NetworkSiblingSet result = await subscriptionResource.QueryNetworkSiblingSetNetAppResourceAsync(location, content);

Console.WriteLine($"Succeeded: {result}");

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

Status code:: 200

{
  "networkSiblingSetId": "9760acf5-4638-11e7-9bdb-020073ca3333",
  "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testVnet/subnets/testSubnet",
  "networkSiblingSetStateId": "12345_44420.8001578125",
  "networkFeatures": "Standard",
  "provisioningState": "Succeeded",
  "nicInfoList": [
    {
      "ipAddress": "1.2.3.4",
      "volumeResourceIds": [
        "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume10",
        "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume11"
      ]
    },
    {
      "ipAddress": "1.2.3.5",
      "volumeResourceIds": [
        "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account2/capacityPools/pool2/volumes/volume20",
        "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account2/capacityPools/pool2/volumes/volume21"
      ]
    },
    {
      "ipAddress": "1.2.3.9",
      "volumeResourceIds": []
    }
  ]
}

Definitioner

Name	Description
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
NetworkFeatures	Nätverksfunktioner
networkSiblingSet	Nätverkskonsyskonuppsättning
NetworkSiblingSetProvisioningState	Hämtar status för NetworkSiblingSet när åtgärden anropades.
nicInfo	NIC-information
QueryNetworkSiblingSetRequest	QueryNetworkSiblingSetRequest

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Den ytterligare informationen.
type	string	Ytterligare informationstyp.

ErrorDetail

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

NetworkFeatures

Nätverksfunktioner

Name	Typ	Description
Basic	string	Grundläggande nätverksfunktioner.
Basic_Standard	string	Uppdaterar från nätverksfunktionerna Basic till Standard.
Standard	string	Standardnätverksfunktioner.
Standard_Basic	string	Uppdaterar från Standard till Basic-nätverksfunktioner.

networkSiblingSet

Nätverkskonsyskonuppsättning

Name	Typ	Standardvärde	Description
networkFeatures	NetworkFeatures	Basic	Nätverksfunktioner Nätverksfunktioner som är tillgängliga för volymen eller aktuellt uppdateringstillstånd.
networkSiblingSetId	string		Nätverkskonsyskonuppsättnings-ID Nätverkskonsyskonuppsättnings-ID för en grupp volymer som delar nätverksresurser i ett undernät.
networkSiblingSetStateId	string		Tillstånds-ID för nätverkskonsyskonuppsättning Tillstånds-ID för nätverkskonsyskonuppsättning som identifierar det aktuella tillståndet för syskonuppsättningen.
nicInfoList	nicInfo[]		Lista över NIC-information
provisioningState	NetworkSiblingSetProvisioningState		Hämtar status för NetworkSiblingSet när åtgärden anropades.
subnetId	string		Resurs-ID för undernätet Azure Resource URI för ett delegerat undernät. Måste ha delegeringen Microsoft.NetApp/volumes. Exempel /subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.Network/virtualNetworks/testVnet/subnets/{mySubnet}

NetworkSiblingSetProvisioningState

Hämtar status för NetworkSiblingSet när åtgärden anropades.

Name	Typ	Description
Canceled	string
Failed	string
Succeeded	string
Updating	string

nicInfo

NIC-information

Name	Typ	Description
ipAddress	string	Ip
volumeResourceIds	string[]	Volymresurs-ID:t

QueryNetworkSiblingSetRequest

Name	Typ	Description
networkSiblingSetId	string	Nätverkskonsyskonuppsättnings-ID Nätverkskonsyskonuppsättnings-ID för en grupp volymer som delar nätverksresurser i ett undernät.
subnetId	string	Resurs-ID för undernätet Azure Resource URI för ett delegerat undernät. Måste ha delegeringen Microsoft.NetApp/volumes. Exempel /subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.Network/virtualNetworks/testVnet/subnets/{mySubnet}

NetApp Resource - Query Network Sibling Set

URI-parametrar

Begärandetext

Svar

Säkerhet

azure_auth

Scopes

Exempel

NetworkSiblingSet_Query

Sample Request

Sample Response

Definitioner

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

NetworkFeatures

networkSiblingSet

NetworkSiblingSetProvisioningState

nicInfo

QueryNetworkSiblingSetRequest

Ytterligare resurser