Managed CCF - Get

服务:

Azure confidential ledger

API 版本:

2024-09-19-preview

检索有关托管 CCF 资源的信息。
检索托管 CCF 应用的属性。

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

URI 参数

名称	在	必需	类型	说明
appName	path	True	string pattern: ^[a-zA-Z0-9]	托管 CCF 的名称
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。 此名称不区分大小写。
subscriptionId	path	True	string minLength: 1	目标订阅的 ID。
api-version	query	True	string minLength: 1	要用于此操作的 API 版本。

响应

名称	类型	说明
200 OK	ManagedCCF	请求成功;响应包含托管 CCF
Other Status Codes	ErrorResponse	描述作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

ManagedCCFGet

示例请求

HTTP

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

Java

/**
 * Samples for ManagedCcf GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2024-09-19-preview/
     * examples/ManagedCCF_Get.json
     */
    /**
     * Sample code: ManagedCCFGet.
     * 
     * @param manager Entry point to ConfidentialLedgerManager.
     */
    public static void managedCCFGet(com.azure.resourcemanager.confidentialledger.ConfidentialLedgerManager manager) {
        manager.managedCcfs().getByResourceGroupWithResponse("DummyResourceGroupName", "DummyMccfAppName",
            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_get.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.get(
        resource_group_name="DummyResourceGroupName",
        app_name="DummyMccfAppName",
    )
    print(response)


# x-ms-original-file: specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2024-09-19-preview/examples/ManagedCCF_Get.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_Get.json
func ExampleManagedCCFClient_Get() {
	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)
	}
	res, err := clientFactory.NewManagedCCFClient().Get(ctx, "DummyResourceGroupName", "DummyMccfAppName", 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.ManagedCCF = armconfidentialledger.ManagedCCF{
	// 	Name: to.Ptr("DummyMccfAppName"),
	// 	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",
	// 				},
	// 		}},
	// 	},
	// }
}

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 a Managed CCF app.
 *
 * @summary Retrieves the properties of a Managed CCF app.
 * x-ms-original-file: specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2024-09-19-preview/examples/ManagedCCF_Get.json
 */
async function managedCcfGet() {
  const subscriptionId =
    process.env["CONFIDENTIALLEDGER_SUBSCRIPTION_ID"] || "0000000-0000-0000-0000-000000000001";
  const resourceGroupName =
    process.env["CONFIDENTIALLEDGER_RESOURCE_GROUP"] || "DummyResourceGroupName";
  const appName = "DummyMccfAppName";
  const credential = new DefaultAzureCredential();
  const client = new ConfidentialLedgerClient(credential, subscriptionId);
  const result = await client.managedCCFOperations.get(resourceGroupName, appName);
  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.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_Get.json
// this example is just showing the usage of "ManagedCCF_Get" 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 ManagedCcfResource
ManagedCcfCollection collection = resourceGroupResource.GetManagedCcfs();

// invoke the operation
string appName = "DummyMccfAppName";
NullableResponse<ManagedCcfResource> response = await collection.GetIfExistsAsync(appName);
ManagedCcfResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // the variable result 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 = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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

示例响应

状态代码:

200

{
  "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"
        }
      }
    ]
  },
  "name": "DummyMccfAppName",
  "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"
  }
}

定义

名称	说明
CertificateTags	托管 CCF 证书的标记
createdByType	创建资源的标识的类型。
DeploymentType	部署类型
EnclavePlatform	表示托管 CCF 应用程序的 enclave 平台的对象。 默认为 IntelSgx。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
LanguageRuntime	表示Manged CCF LanguageRuntime 的对象。
ManagedCCF	托管的 CCF。 包含托管 CCF 资源的属性。
ManagedCCFProperties	托管 CCF 合作伙伴
MemberIdentityCertificate	MemberIdentityCertificate
ProvisioningState	表示托管 CCF 的 ProvisioningState 的对象。
RunningState	表示 Managed CCF 的 RunningState 的对象。
systemData	与创建和上次修改资源相关的元数据。

CertificateTags

Object

托管 CCF 证书的标记

名称	类型	说明
tags	object	托管 CCF 证书的其他标记

createdByType

枚举

创建资源的标识的类型。

值	说明
Application
Key
ManagedIdentity
User

DeploymentType

Object

部署类型

名称	类型	说明
appSourceUri	string	包含 ManagedCCF 代码的源 URI
languageRuntime	LanguageRuntime	托管 CCF 的唯一名称。

EnclavePlatform

枚举

表示托管 CCF 应用程序的 enclave 平台的对象。 默认为 IntelSgx。

值	说明
AmdSevSnp
IntelSgx

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

LanguageRuntime

枚举

表示Manged CCF LanguageRuntime 的对象。

值	说明
CPP
JS

ManagedCCF

Object

托管的 CCF。 包含托管 CCF 资源的属性。

名称	类型	说明
id	string	资源的完全限定资源 ID。 示例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	资源所在的地理位置
name	string	资源的名称
properties	ManagedCCFProperties	托管 CCF 合作伙伴 托管 CCF 资源的属性。
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
tags	object	资源标记。
type	string	资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

ManagedCCFProperties

Object

托管 CCF 合作伙伴

名称	类型	默认值	说明
appName	string		托管 CCF 的唯一名称。
appUri	string		用于调用托管 CCF 服务的终结点。
deploymentType	DeploymentType		部署类型 托管 CCF 的部署类型
enclavePlatform	EnclavePlatform		托管 CCF 的 Enclave 平台。
identityServiceUri	string		用于访问网络标识的终结点。
memberIdentityCertificates	MemberIdentityCertificate[]		托管 CCF 的成员标识证书列表
nodeCount	integer (int32)	3	NodeCount 托管 CCF 中的 CCF 节点数。
provisioningState	ProvisioningState		托管 CCF 资源的预配状态
runningState	RunningState		表示 Managed CCF 的 RunningState 的对象。

MemberIdentityCertificate

Object

MemberIdentityCertificate

名称	类型	说明
certificate	string	成员标识证书
encryptionkey	string	成员标识证书加密密钥
tags	CertificateTags[]	托管 CCF 证书的标记

ProvisioningState

枚举

表示托管 CCF 的 ProvisioningState 的对象。

值	说明
Canceled
Creating
Deleting
Failed
Succeeded
Unknown
Updating

RunningState

枚举

表示 Managed CCF 的 RunningState 的对象。

值	说明
Active
Paused
Pausing
Resuming
Unknown

systemData

Object

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。