Ledger - List By Resource Group

Reference

Služba:: Azure confidential ledger

Verze rozhraní API:: 2022-05-13

Načte informace o všech prostředcích důvěrné knihy v rámci daného předplatného a skupiny prostředků.
Načte vlastnosti všech důvěrných registrů.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConfidentialLedger/ledgers?api-version=2022-05-13

S volitelnými parametry:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConfidentialLedger/ledgers?api-version=2022-05-13&$filter={$filter}

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string minLength: 3 maxLength: 90	Název skupiny prostředků.
subscriptionId	path	True	string	ID předplatného Azure. Jedná se o řetězec formátovaný identifikátorem GUID (např. 00000000-0000-0000-0000-000000000000000).
api-version	query	True	string	Verze rozhraní API, která se má použít s požadavkem HTTP.
$filter	query		string	Filtr, který se má použít v operaci seznamu. Např. $filter=ledgerType ekvalizér 'Veřejný'

Odpovědi

Name	Typ	Description
200 OK	ConfidentialLedgerList	Požadavek byl úspěšný; odpověď obsahuje důvěrné hlavní knihy.
Other Status Codes	ErrorResponse	Odpověď na chybu popisující příčinu selhání operace 404 – Nenalezeno (důvěrné registru neexistuje.)

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

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

ConfidentialLedgerList

Ukázkový požadavek

GET https://management.azure.com/subscriptions/0000000-0000-0000-0000-000000000001/resourceGroups/DummyResourceGroupName/providers/Microsoft.ConfidentialLedger/ledgers?api-version=2022-05-13


/**
 * Samples for Ledger ListByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/stable/2022-05-13/examples/
     * ConfidentialLedger_List.json
     */
    /**
     * Sample code: ConfidentialLedgerList.
     * 
     * @param manager Entry point to ConfidentialLedgerManager.
     */
    public static void
        confidentialLedgerList(com.azure.resourcemanager.confidentialledger.ConfidentialLedgerManager manager) {
        manager.ledgers().listByResourceGroup("DummyResourceGroupName", 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

package armconfidentialledger_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/confidentialledger/armconfidentialledger"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/792db17291c758b2bfdbbc0d35d0e2f5b5a1bd05/specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/stable/2022-05-13/examples/ConfidentialLedger_List.json
func ExampleLedgerClient_NewListByResourceGroupPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armconfidentialledger.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewLedgerClient().NewListByResourceGroupPager("DummyResourceGroupName", &armconfidentialledger.LedgerClientListByResourceGroupOptions{Filter: 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.List = armconfidentialledger.List{
		// 	Value: []*armconfidentialledger.ConfidentialLedger{
		// 		{
		// 			Name: to.Ptr("DummyLedgerName"),
		// 			Type: to.Ptr("Microsoft.ConfidentialLedger/ledgers"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000001/providers/Microsoft.ConfidentialLedger/ledgers/DummyLedgerName"),
		// 			SystemData: &armconfidentialledger.SystemData{
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-12-01T00:00:00.123Z"); return t}()),
		// 				CreatedBy: to.Ptr("ledgerAdmin@contoso.com"),
		// 				CreatedByType: to.Ptr(armconfidentialledger.CreatedByType("Admin1")),
		// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-12-02T00:00:00.123Z"); return t}()),
		// 				LastModifiedBy: to.Ptr("ledgerAdmin2@outlook.com"),
		// 				LastModifiedByType: to.Ptr(armconfidentialledger.CreatedByType("Admin2")),
		// 			},
		// 			Location: to.Ptr("EastUS"),
		// 			Tags: map[string]*string{
		// 				"additionalProps1": to.Ptr("additional properties"),
		// 			},
		// 			Properties: &armconfidentialledger.LedgerProperties{
		// 				AADBasedSecurityPrincipals: []*armconfidentialledger.AADBasedSecurityPrincipal{
		// 					{
		// 						LedgerRoleName: to.Ptr(armconfidentialledger.LedgerRoleNameAdministrator),
		// 						PrincipalID: to.Ptr("34621747-6fc8-4771-a2eb-72f31c461f2e"),
		// 						TenantID: to.Ptr("bce123b9-2b7b-4975-8360-5ca0b9b1cd08"),
		// 				}},
		// 				IdentityServiceURI: to.Ptr("https://dummy.accledger.identity.com/DummyLedgerName"),
		// 				LedgerInternalNamespace: to.Ptr("dummyNamespace"),
		// 				LedgerName: to.Ptr("DummyLedgerName"),
		// 				LedgerType: to.Ptr(armconfidentialledger.LedgerTypePublic),
		// 				LedgerURI: to.Ptr("https://dummy.accledger.domain.com/DummyLedgerName"),
		// 				ProvisioningState: to.Ptr(armconfidentialledger.ProvisioningStateSucceeded),
		// 			},
		// 	}},
		// }
	}
}

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

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

/**
 * This sample demonstrates how to Retrieves the properties of all Confidential Ledgers.
 *
 * @summary Retrieves the properties of all Confidential Ledgers.
 * x-ms-original-file: specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/stable/2022-05-13/examples/ConfidentialLedger_List.json
 */
async function confidentialLedgerList() {
  const subscriptionId =
    process.env["CONFIDENTIALLEDGER_SUBSCRIPTION_ID"] || "0000000-0000-0000-0000-000000000001";
  const resourceGroupName =
    process.env["CONFIDENTIALLEDGER_RESOURCE_GROUP"] || "DummyResourceGroupName";
  const credential = new DefaultAzureCredential();
  const client = new ConfidentialLedgerClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.ledger.listByResourceGroup(resourceGroupName)) {
    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

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.ConfidentialLedger;
using Azure.ResourceManager.ConfidentialLedger.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/stable/2022-05-13/examples/ConfidentialLedger_List.json
// this example is just showing the usage of "Ledger_ListByResourceGroup" 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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "0000000-0000-0000-0000-000000000001";
string resourceGroupName = "DummyResourceGroupName";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this ConfidentialLedgerResource
ConfidentialLedgerCollection collection = resourceGroupResource.GetConfidentialLedgers();

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

Ukázková odpověď

Stavový kód:: 200

{
  "value": [
    {
      "properties": {
        "ledgerName": "DummyLedgerName",
        "ledgerUri": "https://dummy.accledger.domain.com/DummyLedgerName",
        "identityServiceUri": "https://dummy.accledger.identity.com/DummyLedgerName",
        "ledgerType": "Public",
        "ledgerInternalNamespace": "dummyNamespace",
        "provisioningState": "Succeeded",
        "aadBasedSecurityPrincipals": [
          {
            "principalId": "34621747-6fc8-4771-a2eb-72f31c461f2e",
            "tenantId": "bce123b9-2b7b-4975-8360-5ca0b9b1cd08",
            "ledgerRoleName": "Administrator"
          }
        ]
      },
      "name": "DummyLedgerName",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000001/providers/Microsoft.ConfidentialLedger/ledgers/DummyLedgerName",
      "type": "Microsoft.ConfidentialLedger/ledgers",
      "location": "EastUS",
      "tags": {
        "additionalProps1": "additional properties"
      },
      "systemData": {
        "createdBy": "ledgerAdmin@contoso.com",
        "createdByType": "Admin1",
        "createdAt": "2020-12-01T00:00:00.1234567Z",
        "lastModifiedBy": "ledgerAdmin2@outlook.com",
        "lastModifiedByType": "Admin2",
        "lastModifiedAt": "2020-12-02T00:00:00.1234567Z"
      }
    }
  ],
  "nextLink": ""
}

Definice

Name	Description
AADBasedSecurityPrincipal	Objekt zabezpečení založený na AAD s přidruženým názvem role Hlavní knihy
CertBasedSecurityPrincipal	Objekt zabezpečení založený na certifikátech s hlavní rolí RoleName
ConfidentialLedger	Důvěrné registru. Obsahuje vlastnosti důvěrného zdroje registru.
ConfidentialLedgerList	Objekt, který obsahuje pole důvěrných registrů a možný odkaz pro další sadu.
createdByType	Typ identity, která prostředek vytvořila.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
LedgerProperties	Hlavní knihyProperties
LedgerRoleName	Hlavní kniha přidružená k hlavnímu objektu zabezpečení hlavní knihy
LedgerType	Typ důvěrného registru
ProvisioningState	Objekt představující ProvisioningState pro důvěrné hlavní knihy
systemData	Metadata týkající se vytvoření a poslední změny prostředku.

AADBasedSecurityPrincipal

Objekt

Objekt zabezpečení založený na AAD s přidruženým názvem role Hlavní knihy

Name	Typ	Description
ledgerRoleName	LedgerRoleName	Hlavní kniha přidružená k hlavnímu objektu zabezpečení hlavní knihy
principalId	string	ID objektu zabezpečení nebo ID objektu zabezpečení založeného na identifikátoru GUID
tenantId	string	ID tenanta založeného na UUID/GUID objektu zabezpečení

CertBasedSecurityPrincipal

Objekt

Objekt zabezpečení založený na certifikátech s hlavní rolí RoleName

Name	Typ	Description
cert	string	Veřejný klíč certifikátu uživatele (.pem nebo .cer)
ledgerRoleName	LedgerRoleName	Hlavní kniha přidružená k hlavnímu objektu zabezpečení hlavní knihy

ConfidentialLedger

Objekt

Důvěrné registru. Obsahuje vlastnosti důvěrného zdroje registru.

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku pro prostředek.
location	string	Umístění Azure, ve kterém je spuštěný důvěrný registr.
name	string	Název prostředku.
properties	LedgerProperties	Hlavní knihyProperties Vlastnosti důvěrného zdroje registru
systemData	systemData	Metadata týkající se vytvoření a poslední změny prostředku
tags	object	Další značky pro důvěrné registru
type	string	Typ prostředku.

ConfidentialLedgerList

Objekt

Objekt, který obsahuje pole důvěrných registrů a možný odkaz pro další sadu.

Name	Typ	Description
nextLink	string	Adresa URL, pomocí které má klient načíst další stránku (stránkování na straně serveru).
value	ConfidentialLedger[]	Seznam důvěrných registrů

createdByType

Výčet

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

Hodnota	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

LedgerProperties

Objekt

Hlavní knihyProperties

Name	Typ	Description
aadBasedSecurityPrincipals	AADBasedSecurityPrincipal[]	Pole všech objektů zabezpečení založených na AAD
certBasedSecurityPrincipals	CertBasedSecurityPrincipal[]	Pole všech objektů zabezpečení založených na certifikátech
identityServiceUri	string	Koncový bod pro přístup k identitě sítě
ledgerInternalNamespace	string	Interní obor názvů pro hlavní knihy
ledgerName	string	Jedinečný název důvěrného registru.
ledgerType	LedgerType	Typ důvěrného registru
ledgerUri	string	Koncový bod pro volání služby Registru
provisioningState	ProvisioningState	Stav zřizování prostředku hlavní knihy

LedgerRoleName

Výčet

Hlavní kniha přidružená k hlavnímu objektu zabezpečení hlavní knihy

Hodnota	Description
Administrator
Contributor
Reader

LedgerType

Výčet

Typ důvěrného registru

Hodnota	Description
Private
Public
Unknown

ProvisioningState

Výčet

Objekt představující ProvisioningState pro důvěrné hlavní knihy

Hodnota	Description
Canceled
Creating
Deleting
Failed
Succeeded
Unknown
Updating

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.

Sdílet prostřednictvím

Ledger - List By Resource Group

Parametry identifikátoru URI

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

ConfidentialLedgerList

Ukázkový požadavek

Ukázková odpověď

Definice

AADBasedSecurityPrincipal

CertBasedSecurityPrincipal

ConfidentialLedger

ConfidentialLedgerList

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

LedgerProperties

LedgerRoleName

LedgerType

ProvisioningState

systemData