Managed CCF - List By Subscription

Service:

Azure confidential ledger

API Version:

2024-09-19-preview

Retrieves information about all Managed CCF resources under the given subscription
Retrieves the properties of all Managed CCF.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.ConfidentialLedger/managedCCFs/?api-version=2024-09-19-preview

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.ConfidentialLedger/managedCCFs/?api-version=2024-09-19-preview&$filter={$filter}

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
api-version	query	True	string minLength: 1	The API version to use for this operation.
$filter	query		string	The filter to apply on the list operation. eg. $filter=ledgerType eq 'Public'

Responses

Name	Type	Description
200 OK	ManagedCCFList	The request was successful; response contains the list of Managed CCF
Other Status Codes	ErrorResponse	Error response describing the reason for operation failure.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

ManagedCCFListBySub

Sample request

HTTP

GET https://management.azure.com/subscriptions/0000000-0000-0000-0000-000000000001/providers/Microsoft.ConfidentialLedger/managedCCFs/?api-version=2024-09-19-preview

Java

/**
 * Samples for ManagedCcf List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2024-09-19-preview/
     * examples/ManagedCCF_ListBySub.json
     */
    /**
     * Sample code: ManagedCCFListBySub.
     * 
     * @param manager Entry point to ConfidentialLedgerManager.
     */
    public static void
        managedCCFListBySub(com.azure.resourcemanager.confidentialledger.ConfidentialLedgerManager manager) {
        manager.managedCcfs().list(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.confidentialledger import ConfidentialLedger

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-confidentialledger
# USAGE
    python managed_ccf_list_by_sub.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 = ConfidentialLedger(
        credential=DefaultAzureCredential(),
        subscription_id="0000000-0000-0000-0000-000000000001",
    )

    response = client.managed_ccf.list_by_subscription()
    for item in response:
        print(item)


# x-ms-original-file: specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2024-09-19-preview/examples/ManagedCCF_ListBySub.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 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/40c12a2dd76da721d480d55a44e6ec666045d508/specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2024-09-19-preview/examples/ManagedCCF_ListBySub.json
func ExampleManagedCCFClient_NewListBySubscriptionPager() {
	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.NewManagedCCFClient().NewListBySubscriptionPager(&armconfidentialledger.ManagedCCFClientListBySubscriptionOptions{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.ManagedCCFList = armconfidentialledger.ManagedCCFList{
		// 	Value: []*armconfidentialledger.ManagedCCF{
		// 		{
		// 			Name: to.Ptr("DummyLedgerName"),
		// 			Type: to.Ptr("Microsoft.ConfidentialLedger/ManagedCCFs"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000001/providers/Microsoft.ConfidentialLedger/ManagedCCFs/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.ManagedCCFProperties{
		// 				AppName: to.Ptr("DummyMccfAppName"),
		// 				AppURI: to.Ptr("https://dummy.accledger.domain.com/DummyLedgerName"),
		// 				DeploymentType: &armconfidentialledger.DeploymentType{
		// 					AppSourceURI: to.Ptr("https://myaccount.blob.core.windows.net/storage/mccfsource?sv=2022-02-11%st=2022-03-11"),
		// 					LanguageRuntime: to.Ptr(armconfidentialledger.LanguageRuntimeCPP),
		// 				},
		// 				IdentityServiceURI: to.Ptr("https://dummy.accledger.identity.com/DummyLedgerName"),
		// 				MemberIdentityCertificates: []*armconfidentialledger.MemberIdentityCertificate{
		// 					{
		// 						Certificate: to.Ptr("-----BEGIN CERTIFICATE-----MIIBsjCCATigAwIBAgIUZWIbyG79TniQLd2UxJuU74tqrKcwCgYIKoZIzj0EAwMwEDEOMAwGA1UEAwwFdXNlcjAwHhcNMjEwMzE2MTgwNjExWhcNMjIwMzE2MTgwNjExWjAQMQ4wDAYDVQQDDAV1c2VyMDB2MBAGByqGSM49AgEGBSuBBAAiA2IABBiWSo/j8EFit7aUMm5lF+lUmCu+IgfnpFD+7QMgLKtxRJ3aGSqgS/GpqcYVGddnODtSarNE/HyGKUFUolLPQ5ybHcouUk0kyfA7XMeSoUA4lBz63Wha8wmXo+NdBRo39qNTMFEwHQYDVR0OBBYEFPtuhrwgGjDFHeUUT4nGsXaZn69KMB8GA1UdIwQYMBaAFPtuhrwgGjDFHeUUT4nGsXaZn69KMA8GA1UdEwEB/wQFMAMBAf8wCgYIKoZIzj0EAwMDaAAwZQIxAOnozm2CyqRwSSQLls5r+mUHRGRyXHXwYtM4Dcst/VEZdmS9fqvHRCHbjUlO/+HNfgIwMWZ4FmsjD3wnPxONOm9YdVn/PRD7SsPRPbOjwBiE4EBGaHDsLjYAGDSGi7NJnSkA-----END CERTIFICATE-----"),
		// 						Encryptionkey: to.Ptr("ledgerencryptionkey"),
		// 						Tags: map[string]any{
		// 							"additionalProps1": "additional properties",
		// 						},
		// 				}},
		// 				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

JavaScript

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

/**
 * This sample demonstrates how to Retrieves the properties of all Managed CCF.
 *
 * @summary Retrieves the properties of all Managed CCF.
 * x-ms-original-file: specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2024-09-19-preview/examples/ManagedCCF_ListBySub.json
 */
async function managedCcfListBySub() {
  const subscriptionId =
    process.env["CONFIDENTIALLEDGER_SUBSCRIPTION_ID"] || "0000000-0000-0000-0000-000000000001";
  const credential = new DefaultAzureCredential();
  const client = new ConfidentialLedgerClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.managedCCFOperations.listBySubscription()) {
    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.ConfidentialLedger.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.ConfidentialLedger;

// Generated from example definition: specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2024-09-19-preview/examples/ManagedCCF_ListBySub.json
// this example is just showing the usage of "ManagedCCF_ListBySubscription" 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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "0000000-0000-0000-0000-000000000001";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (ManagedCcfResource item in subscriptionResource.GetManagedCcfsAsync())
{
    // 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
    ManagedCcfData 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

Sample response

Status code:

200

{
  "value": [
    {
      "properties": {
        "appName": "DummyMccfAppName",
        "appUri": "https://dummy.accledger.domain.com/DummyLedgerName",
        "identityServiceUri": "https://dummy.accledger.identity.com/DummyLedgerName",
        "deploymentType": {
          "languageRuntime": "CPP",
          "appSourceUri": "https://myaccount.blob.core.windows.net/storage/mccfsource?sv=2022-02-11%st=2022-03-11"
        },
        "memberIdentityCertificates": [
          {
            "certificate": "-----BEGIN CERTIFICATE-----MIIBsjCCATigAwIBAgIUZWIbyG79TniQLd2UxJuU74tqrKcwCgYIKoZIzj0EAwMwEDEOMAwGA1UEAwwFdXNlcjAwHhcNMjEwMzE2MTgwNjExWhcNMjIwMzE2MTgwNjExWjAQMQ4wDAYDVQQDDAV1c2VyMDB2MBAGByqGSM49AgEGBSuBBAAiA2IABBiWSo/j8EFit7aUMm5lF+lUmCu+IgfnpFD+7QMgLKtxRJ3aGSqgS/GpqcYVGddnODtSarNE/HyGKUFUolLPQ5ybHcouUk0kyfA7XMeSoUA4lBz63Wha8wmXo+NdBRo39qNTMFEwHQYDVR0OBBYEFPtuhrwgGjDFHeUUT4nGsXaZn69KMB8GA1UdIwQYMBaAFPtuhrwgGjDFHeUUT4nGsXaZn69KMA8GA1UdEwEB/wQFMAMBAf8wCgYIKoZIzj0EAwMDaAAwZQIxAOnozm2CyqRwSSQLls5r+mUHRGRyXHXwYtM4Dcst/VEZdmS9fqvHRCHbjUlO/+HNfgIwMWZ4FmsjD3wnPxONOm9YdVn/PRD7SsPRPbOjwBiE4EBGaHDsLjYAGDSGi7NJnSkA-----END CERTIFICATE-----",
            "encryptionkey": "ledgerencryptionkey",
            "tags": {
              "additionalProps1": "additional properties"
            }
          }
        ],
        "provisioningState": "Succeeded"
      },
      "name": "DummyLedgerName",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000001/providers/Microsoft.ConfidentialLedger/ManagedCCFs/DummyLedgerName",
      "type": "Microsoft.ConfidentialLedger/ManagedCCFs",
      "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": ""
}

Definitions

Name	Description
CertificateTags	Tags for Managed CCF Certificates
createdByType	The type of identity that created the resource.
DeploymentType	DeploymentType
EnclavePlatform	Object representing the enclave platform for the Managed CCF application. Defaults to IntelSgx.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
LanguageRuntime	Object representing LanguageRuntime for Manged CCF.
ManagedCCF	Managed CCF. Contains the properties of Managed CCF Resource.
ManagedCCFList	Object that includes an array of Managed CCF and a possible link for next set.
ManagedCCFProperties	ManagedCCFProperties
MemberIdentityCertificate	MemberIdentityCertificate
ProvisioningState	Object representing ProvisioningState for Managed CCF.
RunningState	Object representing RunningState for Managed CCF.
systemData	Metadata pertaining to creation and last modification of the resource.

CertificateTags

Object

Tags for Managed CCF Certificates

Name	Type	Description
tags	object	Additional tags for Managed CCF Certificates

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

DeploymentType

Object

DeploymentType

Name	Type	Description
appSourceUri	string	Source Uri containing ManagedCCF code
languageRuntime	LanguageRuntime	Unique name for the Managed CCF.

EnclavePlatform

Enumeration

Object representing the enclave platform for the Managed CCF application. Defaults to IntelSgx.

Value	Description
IntelSgx
AmdSevSnp

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

LanguageRuntime

Enumeration

Object representing LanguageRuntime for Manged CCF.

Value	Description
CPP
JS

ManagedCCF

Object

Managed CCF. Contains the properties of Managed CCF Resource.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	The geo-location where the resource lives
name	string	The name of the resource
properties	ManagedCCFProperties	ManagedCCFProperties Properties of Managed CCF Resource.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ManagedCCFList

Object

Object that includes an array of Managed CCF and a possible link for next set.

Name	Type	Description
nextLink	string	The URL the client should use to fetch the next page (per server side paging).
value	ManagedCCF[]	List of Managed CCF

ManagedCCFProperties

Object

ManagedCCFProperties

Name	Type	Default value	Description
appName	string		Unique name for the Managed CCF.
appUri	string		Endpoint for calling Managed CCF Service.
deploymentType	DeploymentType		DeploymentType Deployment Type of Managed CCF
enclavePlatform	EnclavePlatform		Enclave platform of Managed CCF.
identityServiceUri	string		Endpoint for accessing network identity.
memberIdentityCertificates	MemberIdentityCertificate[]		List of member identity certificates for Managed CCF
nodeCount	integer (int32)	3	NodeCount Number of CCF nodes in the Managed CCF.
provisioningState	ProvisioningState		Provisioning state of Managed CCF Resource
runningState	RunningState		Object representing RunningState for Managed CCF.

MemberIdentityCertificate

Object

MemberIdentityCertificate

Name	Type	Description
certificate	string	Member Identity Certificate
encryptionkey	string	Member Identity Certificate Encryption Key
tags	CertificateTags[]	Tags for Managed CCF Certificates

ProvisioningState

Enumeration

Object representing ProvisioningState for Managed CCF.

Value	Description
Unknown
Succeeded
Failed
Canceled
Creating
Deleting
Updating

RunningState

Enumeration

Object representing RunningState for Managed CCF.

Value	Description
Active
Paused
Unknown
Pausing
Resuming

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.