MHSM Private Link Resources - List By MHSM Resource

Tjänst:

Key Vault

API-version:

2024-11-01

Hämtar de privata länkresurser som stöds för den hanterade hsm-poolen.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/managedHSMs/{name}/privateLinkResources?api-version=2024-11-01

URI-parametrar

Name	I	Obligatorisk	Typ	Description
name	path	True	string	Namnet på den hanterade HSM-poolen
resourceGroupName	path	True	string	Namnet på resursgruppen som innehåller den hanterade HSM-poolen.
subscriptionId	path	True	string	Prenumerationsautentiseringsuppgifter som unikt identifierar Microsoft Azure-prenumeration. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.
api-version	query	True	string	Klient-API-version.

Svar

Name	Typ	Description
200 OK	MHSMPrivateLinkResourceListResult	Resurser för privata länkar har hämtats.
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

KeyVaultListPrivateLinkResources

Exempelbegäran

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/managedHSMs/sample-mhsm/privateLinkResources?api-version=2024-11-01

Java

/**
 * Samples for MhsmPrivateLinkResources ListByMhsmResource.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2024-11-01/examples/
     * ManagedHsm_listPrivateLinkResources.json
     */
    /**
     * Sample code: KeyVaultListPrivateLinkResources.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void keyVaultListPrivateLinkResources(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.vaults().manager().serviceClient().getMhsmPrivateLinkResources()
            .listByMhsmResourceWithResponse("sample-group", "sample-mhsm", 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.keyvault import KeyVaultManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-keyvault
# USAGE
    python managed_hsm_list_private_link_resources.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 = KeyVaultManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.mhsm_private_link_resources.list_by_mhsm_resource(
        resource_group_name="sample-group",
        name="sample-mhsm",
    )
    print(response)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2024-11-01/examples/ManagedHsm_listPrivateLinkResources.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 armkeyvault_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/keyvault/armkeyvault"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ee1eec42dcc710ff88db2d1bf574b2f9afe3d654/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2024-11-01/examples/ManagedHsm_listPrivateLinkResources.json
func ExampleMHSMPrivateLinkResourcesClient_ListByMHSMResource() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armkeyvault.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewMHSMPrivateLinkResourcesClient().ListByMHSMResource(ctx, "sample-group", "sample-mhsm", 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.MHSMPrivateLinkResourceListResult = armkeyvault.MHSMPrivateLinkResourceListResult{
	// 	Value: []*armkeyvault.MHSMPrivateLinkResource{
	// 		{
	// 			Name: to.Ptr("managedhsm"),
	// 			Type: to.Ptr("Microsoft.KeyVault/managedhsms/privateLinkResources"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-resource-group/providers/Microsoft.KeyVault/managedhsms/sample-mhsm/privateLinkResources/managedhsm"),
	// 			Properties: &armkeyvault.MHSMPrivateLinkResourceProperties{
	// 				GroupID: to.Ptr("managedhsms"),
	// 				RequiredMembers: []*string{
	// 					to.Ptr("default")},
	// 					RequiredZoneNames: []*string{
	// 						to.Ptr("privatelink.managedhsm.azure.net")},
	// 					},
	// 			}},
	// 		}
}

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 { KeyVaultManagementClient } = require("@azure/arm-keyvault");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Gets the private link resources supported for the managed hsm pool.
 *
 * @summary Gets the private link resources supported for the managed hsm pool.
 * x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2024-11-01/examples/ManagedHsm_listPrivateLinkResources.json
 */
async function keyVaultListPrivateLinkResources() {
  const subscriptionId =
    process.env["KEYVAULT_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["KEYVAULT_RESOURCE_GROUP"] || "sample-group";
  const name = "sample-mhsm";
  const credential = new DefaultAzureCredential();
  const client = new KeyVaultManagementClient(credential, subscriptionId);
  const result = await client.mhsmPrivateLinkResources.listByMhsmResource(resourceGroupName, name);
  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.KeyVault.Models;
using Azure.ResourceManager.KeyVault;

// Generated from example definition: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2024-11-01/examples/ManagedHsm_listPrivateLinkResources.json
// this example is just showing the usage of "MHSMPrivateLinkResources_ListByManagedHsmResource" 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 ManagedHsmResource created on azure
// for more information of creating ManagedHsmResource, please refer to the document of ManagedHsmResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "sample-group";
string name = "sample-mhsm";
ResourceIdentifier managedHsmResourceId = ManagedHsmResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name);
ManagedHsmResource managedHsm = client.GetManagedHsmResource(managedHsmResourceId);

// invoke the operation and iterate over the result
await foreach (ManagedHsmPrivateLinkResourceData item in managedHsm.GetMHSMPrivateLinkResourcesByManagedHsmResourceAsync())
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine("Succeeded");

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

Exempelsvar

Statuskod:

200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-resource-group/providers/Microsoft.KeyVault/managedhsms/sample-mhsm/privateLinkResources/managedhsm",
      "name": "managedhsm",
      "type": "Microsoft.KeyVault/managedhsms/privateLinkResources",
      "properties": {
        "groupId": "managedhsms",
        "requiredMembers": [
          "default"
        ],
        "requiredZoneNames": [
          "privatelink.managedhsm.azure.net"
        ]
      }
    }
  ]
}

Definitioner

Name	Description
CloudError	Ett felsvar från 密钥保管库 resursprovidern
CloudErrorBody	Ett felsvar från 密钥保管库 resursprovidern
identityType	Den typ av identitet som skapade nyckelvalvsresursen.
ManagedHsmSku	SKU-information
ManagedHsmSkuFamily	SKU-familj för den hanterade HSM-poolen
ManagedHsmSkuName	SKU för den hanterade HSM-poolen
ManagedServiceIdentity	Hanterad tjänstidentitet (systemtilldelade och/eller användartilldelade identiteter)
ManagedServiceIdentityType	Typ av hanterad tjänstidentitet (där både SystemAssigned- och UserAssigned-typer tillåts).
MHSMPrivateLinkResource	En privat länkresurs
MHSMPrivateLinkResourceListResult	En lista över privata länkresurser
SystemData	Metadata som rör skapande och senaste ändring av nyckelvalvsresursen.
UserAssignedIdentity	Användartilldelade identitetsegenskaper

CloudError

Objekt

Ett felsvar från 密钥保管库 resursprovidern

Name	Typ	Description
error	CloudErrorBody	Ett felsvar från 密钥保管库 resursprovidern

CloudErrorBody

Objekt

Ett felsvar från 密钥保管库 resursprovidern

Name	Typ	Description
code	string	Felkod. Detta är en mnemonik som kan användas programmatiskt.
message	string	Användarvänligt felmeddelande. Meddelandet är vanligtvis lokaliserat och kan variera beroende på tjänstversion.

identityType

Uppräkning

Den typ av identitet som skapade nyckelvalvsresursen.

Värde	Description
User
Application
ManagedIdentity
Key

ManagedHsmSku

Objekt

SKU-information

Name	Typ	Description
family	ManagedHsmSkuFamily	SKU-familj för den hanterade HSM-poolen
name	ManagedHsmSkuName	SKU för den hanterade HSM-poolen

ManagedHsmSkuFamily

Uppräkning

SKU-familj för den hanterade HSM-poolen

Värde	Description
B
C

ManagedHsmSkuName

Uppräkning

SKU för den hanterade HSM-poolen

Värde	Description
Standard_B1
Custom_B32
Custom_B6
Custom_C42
Custom_C10

ManagedServiceIdentity

Objekt

Hanterad tjänstidentitet (systemtilldelade och/eller användartilldelade identiteter)

Name	Typ	Description
principalId	string (uuid)	Tjänstens huvudnamns-ID för den systemtilldelade identiteten. Den här egenskapen tillhandahålls endast för en systemtilldelad identitet.
tenantId	string (uuid)	Klientorganisations-ID för den systemtilldelade identiteten. Den här egenskapen tillhandahålls endast för en systemtilldelad identitet.
type	ManagedServiceIdentityType	Typ av hanterad tjänstidentitet (där både SystemAssigned- och UserAssigned-typer tillåts).
userAssignedIdentities	<string,  UserAssignedIdentity>	User-Assigned identiteter Uppsättningen användartilldelade identiteter som är associerade med resursen. Ordlistenycklarna userAssignedIdentities är ARM-resurs-ID:er i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Ordlistevärdena kan vara tomma objekt ({}) i begäranden.

ManagedServiceIdentityType

Uppräkning

Typ av hanterad tjänstidentitet (där både SystemAssigned- och UserAssigned-typer tillåts).

Värde	Description
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

MHSMPrivateLinkResource

Objekt

En privat länkresurs

Name	Typ	Description
id	string	Azure Resource Manager resurs-ID för den hanterade HSM-poolen.
identity	ManagedServiceIdentity	Hanterad tjänstidentitet (systemtilldelade och/eller användartilldelade identiteter)
location	string	Den Azure-plats som stöds där den hanterade HSM-poolen ska skapas.
name	string	Namnet på den hanterade HSM-poolen.
properties.groupId	string	Gruppidentifierare för privat länkresurs.
properties.requiredMembers	string[]	Obligatoriska medlemsnamn för den privata länkresursen.
properties.requiredZoneNames	string[]	Obligatoriska DNS-zonnamn för den privata länkresursen.
sku	ManagedHsmSku	SKU-information
systemData	SystemData	Metadata som rör skapande och senaste ändring av nyckelvalvsresursen.
tags	object	Resursetiketter
type	string	Resurstypen för den hanterade HSM-poolen.

MHSMPrivateLinkResourceListResult

Objekt

En lista över privata länkresurser

Name	Typ	Description
value	MHSMPrivateLinkResource[]	Matris med privata länkresurser

SystemData

Objekt

Metadata som rör skapande och senaste ändring av nyckelvalvsresursen.

Name	Typ	Description
createdAt	string (date-time)	Tidsstämpeln för att skapa nyckelvalvsresursen (UTC).
createdBy	string	Identiteten som skapade nyckelvalvsresursen.
createdByType	identityType	Den typ av identitet som skapade nyckelvalvsresursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för den senaste ändringen av nyckelvalvsresursen (UTC).
lastModifiedBy	string	Identiteten som senast ändrade nyckelvalvsresursen.
lastModifiedByType	identityType	Den typ av identitet som senast ändrade nyckelvalvsresursen.

UserAssignedIdentity

Objekt

Användartilldelade identitetsegenskaper

Name	Typ	Description
clientId	string (uuid)	Klient-ID för den tilldelade identiteten.
principalId	string (uuid)	Huvud-ID för den tilldelade identiteten.