Network Security Perimeter Link References - Get

Služba:

Network security perimeter

Verze rozhraní API:

2024-07-01

Získá zadaný prostředek NSP linkReference.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityPerimeters/{networkSecurityPerimeterName}/linkReferences/{linkReferenceName}?api-version=2024-07-01

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
linkReferenceName	path	True	string maxLength: 80 pattern: (^[a-zA-Z0-9]+[a-zA-Z0-9_.-]*[a-zA-Z0-9_]+$)|(^[a-zA-Z0-9]$)	Název linkReference NSP.
networkSecurityPerimeterName	path	True	string maxLength: 80 pattern: (^[a-zA-Z0-9]+[a-zA-Z0-9_.-]*[a-zA-Z0-9_]+$)|(^[a-zA-Z0-9]$)	Název hraniční sítě.
resourceGroupName	path	True	string	Název skupiny prostředků.
subscriptionId	path	True	string	Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného tvoří součást identifikátoru URI pro každé volání služby.
api-version	query	True	string	Verze rozhraní API klienta.

Odpovědi

Name	Typ	Description
200 OK	NspLinkReference	OK – Vrátí prostředek linkReference NSP.
Other Status Codes	CloudError	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

NspLinkReferencesGet

Ukázkový požadavek

HTTP

GET https://management.azure.com/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp2/linkReferences/link1-guid?api-version=2024-07-01

Java

/**
 * Samples for NetworkSecurityPerimeterLinkReferences Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2024-07-01/examples/NspLinkReferenceGet.json
     */
    /**
     * Sample code: NspLinkReferencesGet.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void nspLinkReferencesGet(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getNetworkSecurityPerimeterLinkReferences().getWithResponse("rg1",
            "nsp2", "link1-guid", 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 nsp_link_reference_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.network_security_perimeter_link_references.get(
        resource_group_name="rg1",
        network_security_perimeter_name="nsp2",
        link_reference_name="link1-guid",
    )
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-07-01/examples/NspLinkReferenceGet.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/v7"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c58fa033619b12c7cfa8a0ec5a9bf03bb18869ab/specification/network/resource-manager/Microsoft.Network/stable/2024-07-01/examples/NspLinkReferenceGet.json
func ExampleSecurityPerimeterLinkReferencesClient_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.NewSecurityPerimeterLinkReferencesClient().Get(ctx, "rg1", "nsp2", "link1-guid", 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.NspLinkReference = armnetwork.NspLinkReference{
	// 	Name: to.Ptr("link1-guid"),
	// 	Type: to.Ptr("Microsoft.Network/networkSecurityPerimeters/linkreferences"),
	// 	ID: to.Ptr("/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp2/linkreferences/link1-guid"),
	// 	SystemData: &armnetwork.SecurityPerimeterSystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2024-02-07T18:07:36.344Z"); return t}()),
	// 		CreatedBy: to.Ptr("user"),
	// 		CreatedByType: to.Ptr(armnetwork.CreatedByTypeUser),
	// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2024-02-07T18:07:36.344Z"); return t}()),
	// 		LastModifiedBy: to.Ptr("user"),
	// 		LastModifiedByType: to.Ptr(armnetwork.CreatedByTypeUser),
	// 	},
	// 	Properties: &armnetwork.NspLinkReferenceProperties{
	// 		Description: to.Ptr("Auto Approved"),
	// 		LocalInboundProfiles: []*string{
	// 			to.Ptr("*")},
	// 			LocalOutboundProfiles: []*string{
	// 				to.Ptr("*")},
	// 				ProvisioningState: to.Ptr(armnetwork.NspLinkProvisioningStateSucceeded),
	// 				RemoteInboundProfiles: []*string{
	// 					to.Ptr("*")},
	// 					RemoteOutboundProfiles: []*string{
	// 						to.Ptr("*")},
	// 						RemotePerimeterGUID: to.Ptr("guid"),
	// 						RemotePerimeterLocation: to.Ptr("westus2"),
	// 						RemotePerimeterResourceID: to.Ptr("/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1"),
	// 						Status: to.Ptr(armnetwork.NspLinkStatusApproved),
	// 					},
	// 				}
}

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");
require("dotenv/config");

/**
 * This sample demonstrates how to Gets the specified NSP linkReference resource.
 *
 * @summary Gets the specified NSP linkReference resource.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-07-01/examples/NspLinkReferenceGet.json
 */
async function nspLinkReferencesGet() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subId";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const networkSecurityPerimeterName = "nsp2";
  const linkReferenceName = "link1-guid";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.networkSecurityPerimeterLinkReferences.get(
    resourceGroupName,
    networkSecurityPerimeterName,
    linkReferenceName,
  );
  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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Network;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2024-07-01/examples/NspLinkReferenceGet.json
// this example is just showing the usage of "NetworkSecurityPerimeterLinkReferences_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://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 NetworkSecurityPerimeterLinkReferenceResource created on azure
// for more information of creating NetworkSecurityPerimeterLinkReferenceResource, please refer to the document of NetworkSecurityPerimeterLinkReferenceResource
string subscriptionId = "subId";
string resourceGroupName = "rg1";
string networkSecurityPerimeterName = "nsp2";
string linkReferenceName = "link1-guid";
ResourceIdentifier networkSecurityPerimeterLinkReferenceResourceId = NetworkSecurityPerimeterLinkReferenceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, networkSecurityPerimeterName, linkReferenceName);
NetworkSecurityPerimeterLinkReferenceResource networkSecurityPerimeterLinkReference = client.GetNetworkSecurityPerimeterLinkReferenceResource(networkSecurityPerimeterLinkReferenceResourceId);

// invoke the operation
NetworkSecurityPerimeterLinkReferenceResource result = await networkSecurityPerimeterLinkReference.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
NetworkSecurityPerimeterLinkReferenceData 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

Ukázková odpověď

Stavový kód:

200

{
  "name": "link1-guid",
  "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp2/linkreferences/link1-guid",
  "type": "Microsoft.Network/networkSecurityPerimeters/linkreferences",
  "properties": {
    "provisioningState": "Succeeded",
    "remotePerimeterResourceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1",
    "remotePerimeterGuid": "guid",
    "remotePerimeterLocation": "westus2",
    "localInboundProfiles": [
      "*"
    ],
    "localOutboundProfiles": [
      "*"
    ],
    "remoteInboundProfiles": [
      "*"
    ],
    "remoteOutboundProfiles": [
      "*"
    ],
    "description": "Auto Approved",
    "status": "Approved"
  },
  "systemData": {
    "createdBy": "user",
    "createdByType": "User",
    "createdAt": "2024-02-07T18:07:36.3446713Z",
    "lastModifiedBy": "user",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-02-07T18:07:36.3446713Z"
  }
}

Definice

Name	Description
CloudError	Chybová odpověď ze služby.
CloudErrorBody	Chybová odpověď ze služby.
createdByType	Typ identity, která prostředek vytvořila.
nspLinkProvisioningState	Stav zřizování prostředku propojení NSP.
NspLinkReference	Prostředek LinkReference pro zabezpečení sítě
nspLinkStatus	Stav propojení NSP.
systemData	Metadata týkající se vytvoření a poslední změny prostředku.

CloudError

Objekt

Chybová odpověď ze služby.

Name	Typ	Description
error	CloudErrorBody	Text chyby cloudu.

CloudErrorBody

Objekt

Chybová odpověď ze služby.

Name	Typ	Description
code	string	Identifikátor chyby. Kódy jsou invariantní a mají být využity programově.
details	CloudErrorBody[]	Seznam dalších podrobností o chybě
message	string	Zpráva popisující chybu, která má být vhodná pro zobrazení v uživatelském rozhraní.
target	string	Cíl konkrétní chyby. Například název vlastnosti v chybě.

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
User
Application
ManagedIdentity
Key

nspLinkProvisioningState

Výčet

Stav zřizování prostředku propojení NSP.

Hodnota	Description
Succeeded
Creating
Updating
Deleting
Accepted
Failed
WaitForRemoteCompletion

NspLinkReference

Objekt

Prostředek LinkReference pro zabezpečení sítě

Name	Typ	Description
id	string (arm-id)	Plně kvalifikované ID prostředku pro prostředek. Například /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Název prostředku
properties.description	string	Zpráva odeslaná vzdáleným správcem propojení NSP pro žádost o připojení. V případě toku s automatickým schválením je ve výchozím nastavení nastavená možnost Auto Approved (Automaticky schváleno).
properties.localInboundProfiles	string[]	Názvy místních příchozích profilů, pro které je povolený příchozí provoz. Pokud chcete povolit příchozí přenosy do všech profilů, použijte [*'].
properties.localOutboundProfiles	string[]	Názvy místních odchozích profilů, ze kterých je povolený odchozí provoz. V aktuální verzi je vlastnost jen pro čtení a její hodnota je nastavená na ['*', aby umožňovala odchozí provoz ze všech profilů. V novější verzi ho uživatel bude moct upravit.
properties.provisioningState	nspLinkProvisioningState	Stav zřizování prostředku NSP LinkReference.
properties.remoteInboundProfiles	string[]	Názvy vzdálených příchozích profilů, u kterých je povolený příchozí provoz. Hodnota [*'] znamená, že příchozí je povolena pro všechny profily ve vzdálené hraniční síti. Tuto vlastnost lze aktualizovat pouze z odpovídajícího prostředku propojení, který se nachází ve vzdálené hraniční síti.
properties.remoteOutboundProfiles	string[]	Vzdálené odchozí názvy profilů, ze kterých je povolený odchozí provoz. Hodnota [*'] znamená, že odchozí provoz je povolený ze všech profilů na vzdálené hraniční síti. Tuto vlastnost lze aktualizovat pouze z odpovídajícího prostředku propojení, který se nachází ve vzdálené hraniční síti.
properties.remotePerimeterGuid	string	Identifikátor GUID vzdáleného ZSP, pomocí kterého je propojení vytvořeno.
properties.remotePerimeterLocation	string	Vzdálené umístění ZSP, pomocí kterého se vytvoří odkaz.
properties.remotePerimeterResourceId	string (arm-id)	ID hraničního ARM pro vzdálený poskytovatel zabezpečení sítě, se kterým je propojení vytvořeno.
properties.status	nspLinkStatus	Stav linkReference NSP. Nelze jej změnit, pokud je odkaz vytvořen v režimu automatického schvalování.
systemData	systemData	Metadata služby Azure Resource Manager obsahující informace o tom, kdo jej vytvořil a upravil.
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

nspLinkStatus

Výčet

Stav propojení NSP.

Hodnota	Description
Approved
Pending
Rejected
Disconnected

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.