Private Link Resource - List By Batch Account

Servicio:

Batch Management

Versión de la API:

2024-07-01

Enumera todos los recursos de private link de la cuenta especificada.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateLinkResources?api-version=2024-07-01

Con parámetros opcionales:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateLinkResources?api-version=2024-07-01&maxresults={maxresults}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
accountName	path	True	string minLength: 3 maxLength: 24 pattern: ^[a-zA-Z0-9]+$	Nombre de la cuenta de Batch.
resourceGroupName	path	True	string	Nombre del grupo de recursos que contiene la cuenta de Batch.
subscriptionId	path	True	string	Identificador de suscripción de Azure. Se trata de una cadena con formato GUID (por ejemplo, 000000000-00000-0000-00000-00000000000000)
api-version	query	True	string	Versión de la API que se va a usar con la solicitud HTTP.
maxresults	query		integer (int32)	Número máximo de elementos que se van a devolver en la respuesta.

Respuestas

Nombre	Tipo	Description
200 OK	ListPrivateLinkResourcesResult	La operación se realizó correctamente. La respuesta contiene una lista de recursos de vínculo privado asociados a la cuenta.
Other Status Codes	CloudError	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de código de autenticación de Microsoft Entra OAuth 2.0

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

ListPrivateLinkResource

Solicitud de ejemplo

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateLinkResources?api-version=2024-07-01

Java

/**
 * Samples for PrivateLinkResource ListByBatchAccount.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/batch/resource-manager/Microsoft.Batch/stable/2024-07-01/examples/PrivateLinkResourcesList.json
     */
    /**
     * Sample code: ListPrivateLinkResource.
     * 
     * @param manager Entry point to BatchManager.
     */
    public static void listPrivateLinkResource(com.azure.resourcemanager.batch.BatchManager manager) {
        manager.privateLinkResources().listByBatchAccount("default-azurebatch-japaneast", "sampleacct", 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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.batch import BatchManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-batch
# USAGE
    python private_link_resources_list.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 = BatchManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.private_link_resource.list_by_batch_account(
        resource_group_name="default-azurebatch-japaneast",
        account_name="sampleacct",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/batch/resource-manager/Microsoft.Batch/stable/2024-07-01/examples/PrivateLinkResourcesList.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 armbatch_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/batch/armbatch/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e79d9ef3e065f2dcb6bd1db51e29c62a99dff5cb/specification/batch/resource-manager/Microsoft.Batch/stable/2024-07-01/examples/PrivateLinkResourcesList.json
func ExamplePrivateLinkResourceClient_NewListByBatchAccountPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armbatch.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewPrivateLinkResourceClient().NewListByBatchAccountPager("default-azurebatch-japaneast", "sampleacct", &armbatch.PrivateLinkResourceClientListByBatchAccountOptions{Maxresults: 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.ListPrivateLinkResourcesResult = armbatch.ListPrivateLinkResourcesResult{
		// 	Value: []*armbatch.PrivateLinkResource{
		// 		{
		// 			Name: to.Ptr("batchAccount"),
		// 			Type: to.Ptr("Microsoft.Batch/batchAccounts/privateLinkResources"),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateLinkResources/batchAccount"),
		// 			Properties: &armbatch.PrivateLinkResourceProperties{
		// 				GroupID: to.Ptr("batchAccount"),
		// 				RequiredMembers: []*string{
		// 					to.Ptr("batchAccount")},
		// 					RequiredZoneNames: []*string{
		// 						to.Ptr("privatelink.japaneast.batch.azure.com")},
		// 					},
		// 			}},
		// 		}
	}
}

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 { BatchManagementClient } = require("@azure/arm-batch");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Lists all of the private link resources in the specified account.
 *
 * @summary Lists all of the private link resources in the specified account.
 * x-ms-original-file: specification/batch/resource-manager/Microsoft.Batch/stable/2024-07-01/examples/PrivateLinkResourcesList.json
 */
async function listPrivateLinkResource() {
  const subscriptionId = process.env["BATCH_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["BATCH_RESOURCE_GROUP"] || "default-azurebatch-japaneast";
  const accountName = "sampleacct";
  const credential = new DefaultAzureCredential();
  const client = new BatchManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.privateLinkResourceOperations.listByBatchAccount(
    resourceGroupName,
    accountName,
  )) {
    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

dotnet

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

// Generated from example definition: specification/batch/resource-manager/Microsoft.Batch/stable/2024-07-01/examples/PrivateLinkResourcesList.json
// this example is just showing the usage of "PrivateLinkResource_ListByBatchAccount" 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 BatchAccountResource created on azure
// for more information of creating BatchAccountResource, please refer to the document of BatchAccountResource
string subscriptionId = "subid";
string resourceGroupName = "default-azurebatch-japaneast";
string accountName = "sampleacct";
ResourceIdentifier batchAccountResourceId = BatchAccountResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName);
BatchAccountResource batchAccount = client.GetBatchAccountResource(batchAccountResourceId);

// get the collection of this BatchPrivateLinkResource
BatchPrivateLinkResourceCollection collection = batchAccount.GetBatchPrivateLinkResources();

// invoke the operation and iterate over the result
await foreach (BatchPrivateLinkResource item in collection.GetAllAsync())
{
    // the variable item 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
    BatchPrivateLinkResourceData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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

Respuesta de muestra

status code:

200

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateLinkResources/batchAccount",
      "name": "batchAccount",
      "type": "Microsoft.Batch/batchAccounts/privateLinkResources",
      "properties": {
        "groupId": "batchAccount",
        "requiredMembers": [
          "batchAccount"
        ],
        "requiredZoneNames": [
          "privatelink.japaneast.batch.azure.com"
        ]
      }
    }
  ]
}

Definiciones

Nombre	Description
CloudError	Respuesta de error del servicio Batch.
CloudErrorBody	Respuesta de error del servicio Batch.
ListPrivateLinkResourcesResult	Valores devueltos por la operación List.
PrivateLinkResource	Contiene información sobre un recurso de vínculo privado.

CloudError

Object

Respuesta de error del servicio Batch.

Nombre	Tipo	Description
error	CloudErrorBody	Cuerpo de la respuesta de error.

CloudErrorBody

Object

Respuesta de error del servicio Batch.

Nombre	Tipo	Description
code	string	Identificador del error. Los códigos son invariables y están diseñados para consumirse mediante programación.
details	CloudErrorBody[]	Lista de detalles adicionales sobre el error.
message	string	Mensaje que describe el error, diseñado para ser adecuado para mostrarse en una interfaz de usuario.
target	string	Destino del error concreto. Por ejemplo, el nombre de la propiedad en error.

ListPrivateLinkResourcesResult

Object

Valores devueltos por la operación List.

Nombre	Tipo	Description
nextLink	string	Token de continuación.
value	PrivateLinkResource[]	Colección de recursos de vínculo privado devueltos.

PrivateLinkResource

Object

Contiene información sobre un recurso de vínculo privado.

Nombre	Tipo	Description
etag	string	ETag del recurso, que se usa para las instrucciones de simultaneidad.
id	string	Identificador del recurso.
name	string	Nombre del recurso.
properties.groupId	string	Identificador de grupo del recurso private link. El identificador de grupo se usa para establecer la conexión de vínculo privado.
properties.requiredMembers	string[]	Lista de miembros necesarios que se usan para establecer la conexión de vínculo privado.
properties.requiredZoneNames	string[]	La lista de nombres de zona necesarios para el nombre de recurso DNS privado
tags	object	Etiquetas del recurso.
type	string	Tipo del recurso.