Secrets - List

Dienst:

Dev Test Labs

API-Version:

2018-09-15

Geheime Schlüssel in einem bestimmten Benutzerprofil auflisten.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/secrets?api-version=2018-09-15

Mit optionalen Parametern:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/secrets?$expand={$expand}&$filter={$filter}&$top={$top}&$orderby={$orderby}&api-version=2018-09-15

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
labName	path	True	string	Der Name des Labors.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe.
subscriptionId	path	True	string	Die Abonnement-ID.
userName	path	True	string	Der Name des Benutzerprofils.
api-version	query	True	string	Client-API-Version.
$expand	query		string	Geben Sie die $expand Abfrage an. Beispiel: 'properties($select=value)'
$filter	query		string	Der Filter, der auf den Vorgang angewendet werden soll. Beispiel: '$filter=contains(name;'myName')
$orderby	query		string	Der Sortierausdruck für die Ergebnisse unter Verwendung der OData-Schreibweise. Beispiel: '$orderby=name desc'
$top	query		integer (int32)	Die maximale Anzahl von Ressourcen, die vom Vorgang zurückgegeben werden sollen. Beispiel: '$top=10'

Antworten

Name	Typ	Beschreibung
200 OK	SecretList	OKAY
Other Status Codes	CloudError	Ungültige Anfrage

Sicherheit

azure_auth

Implizite OAuth2-Gewährung

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Zugreifen auf Microsoft Azure

Beispiele

Secrets_List

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/secrets?api-version=2018-09-15

Java

/**
 * Samples for Secrets List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Secrets_List.json
     */
    /**
     * Sample code: Secrets_List.
     * 
     * @param manager Entry point to DevTestLabsManager.
     */
    public static void secretsList(com.azure.resourcemanager.devtestlabs.DevTestLabsManager manager) {
        manager.secrets().list("resourceGroupName", "{labName}", "{userName}", null, null, null, 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.devtestlabs import DevTestLabsClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-devtestlabs
# USAGE
    python secrets_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 = DevTestLabsClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscriptionId}",
    )

    response = client.secrets.list(
        resource_group_name="resourceGroupName",
        lab_name="{labName}",
        user_name="{userName}",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Secrets_List.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 armdevtestlabs_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/devtestlabs/armdevtestlabs"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Secrets_List.json
func ExampleSecretsClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdevtestlabs.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewSecretsClient().NewListPager("resourceGroupName", "{labName}", "{userName}", &armdevtestlabs.SecretsClientListOptions{Expand: nil,
		Filter:  nil,
		Top:     nil,
		Orderby: 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.SecretList = armdevtestlabs.SecretList{
		// 	Value: []*armdevtestlabs.Secret{
		// 		{
		// 			Name: to.Ptr("secret1"),
		// 			Type: to.Ptr("Microsoft.DevTestLab/labs/users/secrets"),
		// 			ID: to.Ptr("/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/users/{userName}/secrets/secret1"),
		// 			Properties: &armdevtestlabs.SecretProperties{
		// 				UniqueIdentifier: to.Ptr("00000000-0000-0000-0000-000000000000"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("secret2"),
		// 			Type: to.Ptr("Microsoft.DevTestLab/labs/users/secrets"),
		// 			ID: to.Ptr("/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/users/{userName}/secrets/secret2"),
		// 			Properties: &armdevtestlabs.SecretProperties{
		// 				UniqueIdentifier: to.Ptr("00000000-0000-0000-0000-000000000000"),
		// 			},
		// 	}},
		// }
	}
}

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

/**
 * This sample demonstrates how to List secrets in a given user profile.
 *
 * @summary List secrets in a given user profile.
 * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Secrets_List.json
 */
async function secretsList() {
  const subscriptionId = "{subscriptionId}";
  const resourceGroupName = "resourceGroupName";
  const labName = "{labName}";
  const userName = "{userName}";
  const credential = new DefaultAzureCredential();
  const client = new DevTestLabsClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.secrets.list(resourceGroupName, labName, userName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

secretsList().catch(console.error);

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.DevTestLabs;

// Generated from example definition: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Secrets_List.json
// this example is just showing the usage of "Secrets_List" 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 DevTestLabUserResource created on azure
// for more information of creating DevTestLabUserResource, please refer to the document of DevTestLabUserResource
string subscriptionId = "{subscriptionId}";
string resourceGroupName = "resourceGroupName";
string labName = "{labName}";
string userName = "{userName}";
ResourceIdentifier devTestLabUserResourceId = DevTestLabUserResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, labName, userName);
DevTestLabUserResource devTestLabUser = client.GetDevTestLabUserResource(devTestLabUserResourceId);

// get the collection of this DevTestLabSecretResource
DevTestLabSecretCollection collection = devTestLabUser.GetDevTestLabSecrets();

// invoke the operation and iterate over the result
await foreach (DevTestLabSecretResource 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
    DevTestLabSecretData 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

Beispiel für eine Antwort

Statuscode:

200

{
  "value": [
    {
      "properties": {
        "uniqueIdentifier": "00000000-0000-0000-0000-000000000000"
      },
      "id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/users/{userName}/secrets/secret1",
      "name": "secret1",
      "type": "Microsoft.DevTestLab/labs/users/secrets"
    },
    {
      "properties": {
        "uniqueIdentifier": "00000000-0000-0000-0000-000000000000"
      },
      "id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/users/{userName}/secrets/secret2",
      "name": "secret2",
      "type": "Microsoft.DevTestLab/labs/users/secrets"
    }
  ]
}

Definitionen

Name	Beschreibung
CloudError	Fehler aus einer REST-Anforderung.
CloudErrorBody	Textkörper eines Fehlers aus einer REST-Anforderung.
Secret	Ein Geheimnis.
SecretList	Die Antwort eines Listenvorgangs.

CloudError

Objekt

Fehler aus einer REST-Anforderung.

Name	Typ	Beschreibung
error	CloudErrorBody	Der aufgetretene Cloudfehler

CloudErrorBody

Objekt

Textkörper eines Fehlers aus einer REST-Anforderung.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
details	CloudErrorBody[]	Innere Fehler.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

Secret

Objekt

Ein Geheimnis.

Name	Typ	Beschreibung
id	string	Der Bezeichner der Ressource.
location	string	Der Standort der Ressource.
name	string	Der Name der Ressource.
properties.provisioningState	string	Der Bereitstellungsstatus der Ressource.
properties.uniqueIdentifier	string	Der eindeutige unveränderliche Bezeichner einer Ressource (GUID).
properties.value	string	Der Wert des geheimen Schlüssels für die geheime Erstellung.
tags	object	Die Tags der Ressource.
type	string	Der Typ der Ressource.

SecretList

Objekt

Die Antwort eines Listenvorgangs.

Name	Typ	Beschreibung
nextLink	string	Link für die nächste Ergebnismenge.
value	Secret[]	Ergebnisse des Listenvorgangs.