Vpn Link Connections - Get All Shared Keys

Servizio:

Virtual WAN

Versione API:

2024-05-01

Elenca tutte le chiavi condivise della connessione VpnLink specificata.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}/vpnLinkConnections/{linkConnectionName}/sharedKeys?api-version=2024-05-01

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
connectionName	path	True	string	Nome della connessione VPN.
gatewayName	path	True	string	Nome del gateway.
linkConnectionName	path	True	string	Nome della connessione al collegamento VPN.
resourceGroupName	path	True	string	Nome del gruppo di risorse.
subscriptionId	path	True	string	Credenziali della sottoscrizione che identificano in modo univoco la sottoscrizione di Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata al servizio.
api-version	query	True	string	Versione dell'API client.

Risposte

Nome	Tipo	Descrizione
200 OK	ConnectionSharedKeyResultList	Richiesta riuscita. Restituisce la chiave condivisa della connessione al collegamento VPN.
Other Status Codes	CloudError	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

VpnSiteLinkConnectionSharedKeysGet

Esempio di richiesta

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/Connection-Link1/sharedKeys?api-version=2024-05-01

Java

/**
 * Samples for VpnLinkConnections GetAllSharedKeys.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/
     * VpnSiteLinkConnectionSharedKeysGet.json
     */
    /**
     * Sample code: VpnSiteLinkConnectionSharedKeysGet.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void vpnSiteLinkConnectionSharedKeysGet(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getVpnLinkConnections().getAllSharedKeys("rg1", "gateway1",
            "vpnConnection1", "Connection-Link1", 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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python vpn_site_link_connection_shared_keys_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.vpn_link_connections.get_all_shared_keys(
        resource_group_name="rg1",
        gateway_name="gateway1",
        connection_name="vpnConnection1",
        link_connection_name="Connection-Link1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VpnSiteLinkConnectionSharedKeysGet.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

Go

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/ab04533261eff228f28e08900445d0edef3eb70c/specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VpnSiteLinkConnectionSharedKeysGet.json
func ExampleVPNLinkConnectionsClient_NewGetAllSharedKeysPager() {
	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)
	}
	pager := clientFactory.NewVPNLinkConnectionsClient().NewGetAllSharedKeysPager("rg1", "gateway1", "vpnConnection1", "Connection-Link1", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ConnectionSharedKeyResultList = armnetwork.ConnectionSharedKeyResultList{
		// 	Value: []*armnetwork.ConnectionSharedKeyResult{
		// 		{
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/Connection-Link1/sharedKeys/default"),
		// 			Name: to.Ptr("default"),
		// 			Type: to.Ptr("Microsoft.Network/vpnGateways/vpnConnections/vpnLinkConnections/sharedKeys"),
		// 			Properties: &armnetwork.SharedKeyProperties{
		// 				SharedKeyLength: to.Ptr[int32](16),
		// 			},
		// 	}},
		// }
	}
}

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

JavaScript

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

/**
 * This sample demonstrates how to Lists all shared keys of VpnLink connection specified.
 *
 * @summary Lists all shared keys of VpnLink connection specified.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VpnSiteLinkConnectionSharedKeysGet.json
 */
async function vpnSiteLinkConnectionSharedKeysGet() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const gatewayName = "gateway1";
  const connectionName = "vpnConnection1";
  const linkConnectionName = "Connection-Link1";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.vpnLinkConnections.listAllSharedKeys(
    resourceGroupName,
    gatewayName,
    connectionName,
    linkConnectionName,
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

Risposta di esempio

Codice di stato:

200

{
  "value": [
    {
      "name": "default",
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/Connection-Link1/sharedKeys/default",
      "type": "Microsoft.Network/vpnGateways/vpnConnections/vpnLinkConnections/sharedKeys",
      "properties": {
        "sharedKeyLength": 16
      }
    }
  ]
}

Definizioni

Nome	Descrizione
CloudError	Risposta di errore dal servizio.
CloudErrorBody	Risposta di errore dal servizio.
ConnectionSharedKeyResult	Risorsa SharedKey.
ConnectionSharedKeyResultList	Elenco di chiavi condivise per la connessione al collegamento VPN. Deve contenere solo una chiave condivisa per ogni connessione di collegamento VPN.
ProvisioningState	Stato di provisioning corrente.
SharedKeyProperties	Parametri per SharedKey.

CloudError

Object

Risposta di errore dal servizio.

Nome	Tipo	Descrizione
error	CloudErrorBody	Corpo dell'errore cloud.

CloudErrorBody

Object

Risposta di errore dal servizio.

Nome	Tipo	Descrizione
code	string	Identificatore dell'errore. I codici sono invarianti e devono essere utilizzati a livello di codice.
details	CloudErrorBody[]	Elenco di dettagli aggiuntivi sull'errore.
message	string	Messaggio che descrive l'errore, destinato a essere adatto per la visualizzazione in un'interfaccia utente.
target	string	Destinazione dell'errore specifico. Ad esempio, il nome della proprietà in errore.

ConnectionSharedKeyResult

Object

Risorsa SharedKey.

Nome	Tipo	Descrizione
id	string	Identificatore della chiave condivisa per una connessione di collegamento VPN.
name	string	Nome della risorsa univoca all'interno di un gruppo di risorse. Questo nome può essere usato per accedere alla risorsa.
properties	SharedKeyProperties	Proprietà della chiave condivisa.
type	string	Tipo di risorsa.

ConnectionSharedKeyResultList

Object

Elenco di chiavi condivise per la connessione al collegamento VPN. Deve contenere solo una chiave condivisa per ogni connessione di collegamento VPN.

Nome	Tipo	Descrizione
nextLink	string	URL per ottenere il set successivo di risultati dell'elenco di operazioni, se presenti.
value	ConnectionSharedKeyResult[]	Elenco di SharedKeys.

ProvisioningState

Enumerazione

Stato di provisioning corrente.

Valore	Descrizione
Deleting
Failed
Succeeded
Updating

SharedKeyProperties

Object

Parametri per SharedKey.

Nome	Tipo	Descrizione
provisioningState	ProvisioningState	Stato di provisioning della risorsa SharedKey.
sharedKey	string	Valore della chiave condivisa per la connessione al collegamento VPN.
sharedKeyLength	integer (int32) minimum: 1 maximum: 128	Lunghezza della chiave condivisa per la connessione al collegamento VPN.