Microsoft.ConfidentialLedger (preview:2024-09-19)

2025/01/08 • 18 new methods

Operations_List (new)
Description :  Retrieves a list of available API operations
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ConfidentialLedger/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Resource provider operations list. ,
Required: False ,
}
[
{
name:
{
Description: Resource provider operation name. ,
Required: False ,
}
string ,
isDataAction:
{
Description: Indicates whether the operation is data action or not. ,
Required: False ,
}
boolean ,
display:
{
Description: Details about the operations ,
Required: False ,
}
{
provider:
{
Description: Name of the resource provider. ,
Required: False ,
}
string ,
resource:
{
Description: Name of the resource type. ,
Required: False ,
}
string ,
operation:
{
Description: Name of the resource provider operation. ,
Required: False ,
}
string ,
description:
{
Description: Description of the resource provider operation. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URI that can be used to request the next page for list of Azure operations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CheckNameAvailability (new)
Description :  To check whether a resource name is available.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.ConfidentialLedger/checkNameAvailability
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
nameAvailabilityRequest:
{
Description: Name availability request payload. ,
Required: True ,
}
{
name:
{
Description: The name of the resource for which availability needs to be checked. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Indicates if the resource name is available. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason why the given name is not available. ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Detailed reason why the given name is available. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Ledger_Get (new)
Description :  Retrieves the properties of a Confidential Ledger.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConfidentialLedger/ledgers/{ledgerName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
ledgerName:
{
Description: Name of the Confidential Ledger ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of Confidential Ledger Resource. ,
Required: False ,
}
{
ledgerName:
{
Description: Unique name for the Confidential Ledger. ,
Required: False ,
}
string ,
ledgerUri:
{
Description: Endpoint for calling Ledger Service. ,
Required: False ,
}
string ,
identityServiceUri:
{
Description: Endpoint for accessing network identity. ,
Required: False ,
}
string ,
ledgerInternalNamespace:
{
Description: Internal namespace for the Ledger ,
Required: False ,
}
string ,
runningState:
{
Description: Object representing RunningState for Ledger. ,
Enum:
{
Active: No description available. ,
Paused: No description available. ,
Unknown: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
}
,
Required: False ,
}
enum ,
ledgerType:
{
Description: Type of Confidential Ledger ,
Enum:
{
Unknown: No description available. ,
Public: No description available. ,
Private: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of Ledger Resource ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
ledgerSku:
{
Description: SKU associated with the ledger ,
Enum:
{
Standard: No description available. ,
Basic: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
aadBasedSecurityPrincipals:
{
Description: Array of all AAD based Security Principals. ,
Required: False ,
}
[
{
principalId:
{
Description: UUID/GUID based Principal Id of the Security Principal ,
Required: False ,
}
string ,
tenantId:
{
Description: UUID/GUID based Tenant Id of the Security Principal ,
Required: False ,
}
string ,
ledgerRoleName:
{
Description: LedgerRole associated with the Security Principal of Ledger ,
Enum:
{
Reader: No description available. ,
Contributor: No description available. ,
Administrator: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
certBasedSecurityPrincipals:
{
Description: Array of all cert based Security Principals. ,
Required: False ,
}
[
{
cert:
{
Description: Public key of the user cert (.pem or .cer) ,
Required: False ,
}
string ,
ledgerRoleName:
{
Description: LedgerRole associated with the Security Principal of Ledger ,
Enum:
{
Reader: No description available. ,
Contributor: No description available. ,
Administrator: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hostLevel:
{
Description: CCF Property for the logging level for the untrusted host: Trace, Debug, Info, Fail, Fatal. ,
Required: False ,
}
string ,
maxBodySizeInMb:
{
Description: CCF Property for the maximum size of the http request body: 1MB, 5MB, 10MB. ,
Format: int32 ,
Required: False ,
}
integer ,
subjectName:
{
Description: CCF Property for the subject name to include in the node certificate. Default: CN=CCF Node. ,
Required: False ,
}
string ,
nodeCount:
{
Description: Number of CCF nodes in the ACC Ledger. ,
Format: int32 ,
Required: False ,
}
integer ,
writeLBAddressPrefix:
{
Description: Prefix for the write load balancer. Example: write ,
Required: False ,
}
string ,
workerThreads:
{
Description: Number of additional threads processing incoming client requests in the enclave (modify with care!) ,
Format: int32 ,
Required: False ,
}
integer ,
enclavePlatform:
{
Description: Enclave platform of the Confidential Ledger. ,
Enum:
{
IntelSgx: No description available. ,
AmdSevSnp: No description available. ,
}
,
Required: False ,
}
enum ,
applicationType:
{
Description: Application type of the Confidential Ledger. ,
Enum:
{
ConfidentialLedger: No description available. ,
CodeTransparency: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Ledger_Delete (new)
Description :  Deletes an existing Confidential Ledger.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConfidentialLedger/ledgers/{ledgerName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
ledgerName:
{
Description: Name of the Confidential Ledger ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Ledger_Create (new)
Description :  Creates a Confidential Ledger with the specified ledger parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConfidentialLedger/ledgers/{ledgerName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
ledgerName:
{
Description: Name of the Confidential Ledger ,
Required: True ,
}
string ,
confidentialLedger:
{
Description: Confidential Ledger Create Request Body ,
Required: True ,
}
{
properties:
{
Description: Properties of Confidential Ledger Resource. ,
Required: False ,
}
{
ledgerName:
{
Description: Unique name for the Confidential Ledger. ,
Required: False ,
}
string ,
ledgerUri:
{
Description: Endpoint for calling Ledger Service. ,
Required: False ,
}
string ,
identityServiceUri:
{
Description: Endpoint for accessing network identity. ,
Required: False ,
}
string ,
ledgerInternalNamespace:
{
Description: Internal namespace for the Ledger ,
Required: False ,
}
string ,
runningState:
{
Description: Object representing RunningState for Ledger. ,
Enum:
{
Active: No description available. ,
Paused: No description available. ,
Unknown: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
}
,
Required: False ,
}
enum ,
ledgerType:
{
Description: Type of Confidential Ledger ,
Enum:
{
Unknown: No description available. ,
Public: No description available. ,
Private: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of Ledger Resource ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
ledgerSku:
{
Description: SKU associated with the ledger ,
Enum:
{
Standard: No description available. ,
Basic: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
aadBasedSecurityPrincipals:
{
Description: Array of all AAD based Security Principals. ,
Required: False ,
}
[
{
principalId:
{
Description: UUID/GUID based Principal Id of the Security Principal ,
Required: False ,
}
string ,
tenantId:
{
Description: UUID/GUID based Tenant Id of the Security Principal ,
Required: False ,
}
string ,
ledgerRoleName:
{
Description: LedgerRole associated with the Security Principal of Ledger ,
Enum:
{
Reader: No description available. ,
Contributor: No description available. ,
Administrator: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
certBasedSecurityPrincipals:
{
Description: Array of all cert based Security Principals. ,
Required: False ,
}
[
{
cert:
{
Description: Public key of the user cert (.pem or .cer) ,
Required: False ,
}
string ,
ledgerRoleName:
{
Description: LedgerRole associated with the Security Principal of Ledger ,
Enum:
{
Reader: No description available. ,
Contributor: No description available. ,
Administrator: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hostLevel:
{
Description: CCF Property for the logging level for the untrusted host: Trace, Debug, Info, Fail, Fatal. ,
Required: False ,
}
string ,
maxBodySizeInMb:
{
Description: CCF Property for the maximum size of the http request body: 1MB, 5MB, 10MB. ,
Format: int32 ,
Required: False ,
}
integer ,
subjectName:
{
Description: CCF Property for the subject name to include in the node certificate. Default: CN=CCF Node. ,
Required: False ,
}
string ,
nodeCount:
{
Description: Number of CCF nodes in the ACC Ledger. ,
Format: int32 ,
Required: False ,
}
integer ,
writeLBAddressPrefix:
{
Description: Prefix for the write load balancer. Example: write ,
Required: False ,
}
string ,
workerThreads:
{
Description: Number of additional threads processing incoming client requests in the enclave (modify with care!) ,
Format: int32 ,
Required: False ,
}
integer ,
enclavePlatform:
{
Description: Enclave platform of the Confidential Ledger. ,
Enum:
{
IntelSgx: No description available. ,
AmdSevSnp: No description available. ,
}
,
Required: False ,
}
enum ,
applicationType:
{
Description: Application type of the Confidential Ledger. ,
Enum:
{
ConfidentialLedger: No description available. ,
CodeTransparency: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of Confidential Ledger Resource. ,
Required: False ,
}
{
ledgerName:
{
Description: Unique name for the Confidential Ledger. ,
Required: False ,
}
string ,
ledgerUri:
{
Description: Endpoint for calling Ledger Service. ,
Required: False ,
}
string ,
identityServiceUri:
{
Description: Endpoint for accessing network identity. ,
Required: False ,
}
string ,
ledgerInternalNamespace:
{
Description: Internal namespace for the Ledger ,
Required: False ,
}
string ,
runningState:
{
Description: Object representing RunningState for Ledger. ,
Enum:
{
Active: No description available. ,
Paused: No description available. ,
Unknown: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
}
,
Required: False ,
}
enum ,
ledgerType:
{
Description: Type of Confidential Ledger ,
Enum:
{
Unknown: No description available. ,
Public: No description available. ,
Private: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of Ledger Resource ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
ledgerSku:
{
Description: SKU associated with the ledger ,
Enum:
{
Standard: No description available. ,
Basic: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
aadBasedSecurityPrincipals:
{
Description: Array of all AAD based Security Principals. ,
Required: False ,
}
[
{
principalId:
{
Description: UUID/GUID based Principal Id of the Security Principal ,
Required: False ,
}
string ,
tenantId:
{
Description: UUID/GUID based Tenant Id of the Security Principal ,
Required: False ,
}
string ,
ledgerRoleName:
{
Description: LedgerRole associated with the Security Principal of Ledger ,
Enum:
{
Reader: No description available. ,
Contributor: No description available. ,
Administrator: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
certBasedSecurityPrincipals:
{
Description: Array of all cert based Security Principals. ,
Required: False ,
}
[
{
cert:
{
Description: Public key of the user cert (.pem or .cer) ,
Required: False ,
}
string ,
ledgerRoleName:
{
Description: LedgerRole associated with the Security Principal of Ledger ,
Enum:
{
Reader: No description available. ,
Contributor: No description available. ,
Administrator: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hostLevel:
{
Description: CCF Property for the logging level for the untrusted host: Trace, Debug, Info, Fail, Fatal. ,
Required: False ,
}
string ,
maxBodySizeInMb:
{
Description: CCF Property for the maximum size of the http request body: 1MB, 5MB, 10MB. ,
Format: int32 ,
Required: False ,
}
integer ,
subjectName:
{
Description: CCF Property for the subject name to include in the node certificate. Default: CN=CCF Node. ,
Required: False ,
}
string ,
nodeCount:
{
Description: Number of CCF nodes in the ACC Ledger. ,
Format: int32 ,
Required: False ,
}
integer ,
writeLBAddressPrefix:
{
Description: Prefix for the write load balancer. Example: write ,
Required: False ,
}
string ,
workerThreads:
{
Description: Number of additional threads processing incoming client requests in the enclave (modify with care!) ,
Format: int32 ,
Required: False ,
}
integer ,
enclavePlatform:
{
Description: Enclave platform of the Confidential Ledger. ,
Enum:
{
IntelSgx: No description available. ,
AmdSevSnp: No description available. ,
}
,
Required: False ,
}
enum ,
applicationType:
{
Description: Application type of the Confidential Ledger. ,
Enum:
{
ConfidentialLedger: No description available. ,
CodeTransparency: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of Confidential Ledger Resource. ,
Required: False ,
}
{
ledgerName:
{
Description: Unique name for the Confidential Ledger. ,
Required: False ,
}
string ,
ledgerUri:
{
Description: Endpoint for calling Ledger Service. ,
Required: False ,
}
string ,
identityServiceUri:
{
Description: Endpoint for accessing network identity. ,
Required: False ,
}
string ,
ledgerInternalNamespace:
{
Description: Internal namespace for the Ledger ,
Required: False ,
}
string ,
runningState:
{
Description: Object representing RunningState for Ledger. ,
Enum:
{
Active: No description available. ,
Paused: No description available. ,
Unknown: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
}
,
Required: False ,
}
enum ,
ledgerType:
{
Description: Type of Confidential Ledger ,
Enum:
{
Unknown: No description available. ,
Public: No description available. ,
Private: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of Ledger Resource ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
ledgerSku:
{
Description: SKU associated with the ledger ,
Enum:
{
Standard: No description available. ,
Basic: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
aadBasedSecurityPrincipals:
{
Description: Array of all AAD based Security Principals. ,
Required: False ,
}
[
{
principalId:
{
Description: UUID/GUID based Principal Id of the Security Principal ,
Required: False ,
}
string ,
tenantId:
{
Description: UUID/GUID based Tenant Id of the Security Principal ,
Required: False ,
}
string ,
ledgerRoleName:
{
Description: LedgerRole associated with the Security Principal of Ledger ,
Enum:
{
Reader: No description available. ,
Contributor: No description available. ,
Administrator: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
certBasedSecurityPrincipals:
{
Description: Array of all cert based Security Principals. ,
Required: False ,
}
[
{
cert:
{
Description: Public key of the user cert (.pem or .cer) ,
Required: False ,
}
string ,
ledgerRoleName:
{
Description: LedgerRole associated with the Security Principal of Ledger ,
Enum:
{
Reader: No description available. ,
Contributor: No description available. ,
Administrator: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hostLevel:
{
Description: CCF Property for the logging level for the untrusted host: Trace, Debug, Info, Fail, Fatal. ,
Required: False ,
}
string ,
maxBodySizeInMb:
{
Description: CCF Property for the maximum size of the http request body: 1MB, 5MB, 10MB. ,
Format: int32 ,
Required: False ,
}
integer ,
subjectName:
{
Description: CCF Property for the subject name to include in the node certificate. Default: CN=CCF Node. ,
Required: False ,
}
string ,
nodeCount:
{
Description: Number of CCF nodes in the ACC Ledger. ,
Format: int32 ,
Required: False ,
}
integer ,
writeLBAddressPrefix:
{
Description: Prefix for the write load balancer. Example: write ,
Required: False ,
}
string ,
workerThreads:
{
Description: Number of additional threads processing incoming client requests in the enclave (modify with care!) ,
Format: int32 ,
Required: False ,
}
integer ,
enclavePlatform:
{
Description: Enclave platform of the Confidential Ledger. ,
Enum:
{
IntelSgx: No description available. ,
AmdSevSnp: No description available. ,
}
,
Required: False ,
}
enum ,
applicationType:
{
Description: Application type of the Confidential Ledger. ,
Enum:
{
ConfidentialLedger: No description available. ,
CodeTransparency: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Ledger_Update (new)
Description :  Updates properties of Confidential Ledger
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConfidentialLedger/ledgers/{ledgerName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
ledgerName:
{
Description: Name of the Confidential Ledger ,
Required: True ,
}
string ,
confidentialLedger:
{
Description: Confidential Ledger request body for Updating Ledger ,
Required: True ,
}
{
properties:
{
Description: Properties of Confidential Ledger Resource. ,
Required: False ,
}
{
ledgerName:
{
Description: Unique name for the Confidential Ledger. ,
Required: False ,
}
string ,
ledgerUri:
{
Description: Endpoint for calling Ledger Service. ,
Required: False ,
}
string ,
identityServiceUri:
{
Description: Endpoint for accessing network identity. ,
Required: False ,
}
string ,
ledgerInternalNamespace:
{
Description: Internal namespace for the Ledger ,
Required: False ,
}
string ,
runningState:
{
Description: Object representing RunningState for Ledger. ,
Enum:
{
Active: No description available. ,
Paused: No description available. ,
Unknown: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
}
,
Required: False ,
}
enum ,
ledgerType:
{
Description: Type of Confidential Ledger ,
Enum:
{
Unknown: No description available. ,
Public: No description available. ,
Private: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of Ledger Resource ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
ledgerSku:
{
Description: SKU associated with the ledger ,
Enum:
{
Standard: No description available. ,
Basic: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
aadBasedSecurityPrincipals:
{
Description: Array of all AAD based Security Principals. ,
Required: False ,
}
[
{
principalId:
{
Description: UUID/GUID based Principal Id of the Security Principal ,
Required: False ,
}
string ,
tenantId:
{
Description: UUID/GUID based Tenant Id of the Security Principal ,
Required: False ,
}
string ,
ledgerRoleName:
{
Description: LedgerRole associated with the Security Principal of Ledger ,
Enum:
{
Reader: No description available. ,
Contributor: No description available. ,
Administrator: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
certBasedSecurityPrincipals:
{
Description: Array of all cert based Security Principals. ,
Required: False ,
}
[
{
cert:
{
Description: Public key of the user cert (.pem or .cer) ,
Required: False ,
}
string ,
ledgerRoleName:
{
Description: LedgerRole associated with the Security Principal of Ledger ,
Enum:
{
Reader: No description available. ,
Contributor: No description available. ,
Administrator: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hostLevel:
{
Description: CCF Property for the logging level for the untrusted host: Trace, Debug, Info, Fail, Fatal. ,
Required: False ,
}
string ,
maxBodySizeInMb:
{
Description: CCF Property for the maximum size of the http request body: 1MB, 5MB, 10MB. ,
Format: int32 ,
Required: False ,
}
integer ,
subjectName:
{
Description: CCF Property for the subject name to include in the node certificate. Default: CN=CCF Node. ,
Required: False ,
}
string ,
nodeCount:
{
Description: Number of CCF nodes in the ACC Ledger. ,
Format: int32 ,
Required: False ,
}
integer ,
writeLBAddressPrefix:
{
Description: Prefix for the write load balancer. Example: write ,
Required: False ,
}
string ,
workerThreads:
{
Description: Number of additional threads processing incoming client requests in the enclave (modify with care!) ,
Format: int32 ,
Required: False ,
}
integer ,
enclavePlatform:
{
Description: Enclave platform of the Confidential Ledger. ,
Enum:
{
IntelSgx: No description available. ,
AmdSevSnp: No description available. ,
}
,
Required: False ,
}
enum ,
applicationType:
{
Description: Application type of the Confidential Ledger. ,
Enum:
{
ConfidentialLedger: No description available. ,
CodeTransparency: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of Confidential Ledger Resource. ,
Required: False ,
}
{
ledgerName:
{
Description: Unique name for the Confidential Ledger. ,
Required: False ,
}
string ,
ledgerUri:
{
Description: Endpoint for calling Ledger Service. ,
Required: False ,
}
string ,
identityServiceUri:
{
Description: Endpoint for accessing network identity. ,
Required: False ,
}
string ,
ledgerInternalNamespace:
{
Description: Internal namespace for the Ledger ,
Required: False ,
}
string ,
runningState:
{
Description: Object representing RunningState for Ledger. ,
Enum:
{
Active: No description available. ,
Paused: No description available. ,
Unknown: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
}
,
Required: False ,
}
enum ,
ledgerType:
{
Description: Type of Confidential Ledger ,
Enum:
{
Unknown: No description available. ,
Public: No description available. ,
Private: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of Ledger Resource ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
ledgerSku:
{
Description: SKU associated with the ledger ,
Enum:
{
Standard: No description available. ,
Basic: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
aadBasedSecurityPrincipals:
{
Description: Array of all AAD based Security Principals. ,
Required: False ,
}
[
{
principalId:
{
Description: UUID/GUID based Principal Id of the Security Principal ,
Required: False ,
}
string ,
tenantId:
{
Description: UUID/GUID based Tenant Id of the Security Principal ,
Required: False ,
}
string ,
ledgerRoleName:
{
Description: LedgerRole associated with the Security Principal of Ledger ,
Enum:
{
Reader: No description available. ,
Contributor: No description available. ,
Administrator: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
certBasedSecurityPrincipals:
{
Description: Array of all cert based Security Principals. ,
Required: False ,
}
[
{
cert:
{
Description: Public key of the user cert (.pem or .cer) ,
Required: False ,
}
string ,
ledgerRoleName:
{
Description: LedgerRole associated with the Security Principal of Ledger ,
Enum:
{
Reader: No description available. ,
Contributor: No description available. ,
Administrator: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hostLevel:
{
Description: CCF Property for the logging level for the untrusted host: Trace, Debug, Info, Fail, Fatal. ,
Required: False ,
}
string ,
maxBodySizeInMb:
{
Description: CCF Property for the maximum size of the http request body: 1MB, 5MB, 10MB. ,
Format: int32 ,
Required: False ,
}
integer ,
subjectName:
{
Description: CCF Property for the subject name to include in the node certificate. Default: CN=CCF Node. ,
Required: False ,
}
string ,
nodeCount:
{
Description: Number of CCF nodes in the ACC Ledger. ,
Format: int32 ,
Required: False ,
}
integer ,
writeLBAddressPrefix:
{
Description: Prefix for the write load balancer. Example: write ,
Required: False ,
}
string ,
workerThreads:
{
Description: Number of additional threads processing incoming client requests in the enclave (modify with care!) ,
Format: int32 ,
Required: False ,
}
integer ,
enclavePlatform:
{
Description: Enclave platform of the Confidential Ledger. ,
Enum:
{
IntelSgx: No description available. ,
AmdSevSnp: No description available. ,
}
,
Required: False ,
}
enum ,
applicationType:
{
Description: Application type of the Confidential Ledger. ,
Enum:
{
ConfidentialLedger: No description available. ,
CodeTransparency: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Ledger_ListByResourceGroup (new)
Description :  Retrieves the properties of all Confidential Ledgers.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConfidentialLedger/ledgers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the list operation. eg. $filter=ledgerType eq 'Public' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Confidential Ledgers ,
Required: False ,
}
[
{
properties:
{
Description: Properties of Confidential Ledger Resource. ,
Required: False ,
}
{
ledgerName:
{
Description: Unique name for the Confidential Ledger. ,
Required: False ,
}
string ,
ledgerUri:
{
Description: Endpoint for calling Ledger Service. ,
Required: False ,
}
string ,
identityServiceUri:
{
Description: Endpoint for accessing network identity. ,
Required: False ,
}
string ,
ledgerInternalNamespace:
{
Description: Internal namespace for the Ledger ,
Required: False ,
}
string ,
runningState:
{
Description: Object representing RunningState for Ledger. ,
Enum:
{
Active: No description available. ,
Paused: No description available. ,
Unknown: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
}
,
Required: False ,
}
enum ,
ledgerType:
{
Description: Type of Confidential Ledger ,
Enum:
{
Unknown: No description available. ,
Public: No description available. ,
Private: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of Ledger Resource ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
ledgerSku:
{
Description: SKU associated with the ledger ,
Enum:
{
Standard: No description available. ,
Basic: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
aadBasedSecurityPrincipals:
{
Description: Array of all AAD based Security Principals. ,
Required: False ,
}
[
{
principalId:
{
Description: UUID/GUID based Principal Id of the Security Principal ,
Required: False ,
}
string ,
tenantId:
{
Description: UUID/GUID based Tenant Id of the Security Principal ,
Required: False ,
}
string ,
ledgerRoleName:
{
Description: LedgerRole associated with the Security Principal of Ledger ,
Enum:
{
Reader: No description available. ,
Contributor: No description available. ,
Administrator: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
certBasedSecurityPrincipals:
{
Description: Array of all cert based Security Principals. ,
Required: False ,
}
[
{
cert:
{
Description: Public key of the user cert (.pem or .cer) ,
Required: False ,
}
string ,
ledgerRoleName:
{
Description: LedgerRole associated with the Security Principal of Ledger ,
Enum:
{
Reader: No description available. ,
Contributor: No description available. ,
Administrator: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hostLevel:
{
Description: CCF Property for the logging level for the untrusted host: Trace, Debug, Info, Fail, Fatal. ,
Required: False ,
}
string ,
maxBodySizeInMb:
{
Description: CCF Property for the maximum size of the http request body: 1MB, 5MB, 10MB. ,
Format: int32 ,
Required: False ,
}
integer ,
subjectName:
{
Description: CCF Property for the subject name to include in the node certificate. Default: CN=CCF Node. ,
Required: False ,
}
string ,
nodeCount:
{
Description: Number of CCF nodes in the ACC Ledger. ,
Format: int32 ,
Required: False ,
}
integer ,
writeLBAddressPrefix:
{
Description: Prefix for the write load balancer. Example: write ,
Required: False ,
}
string ,
workerThreads:
{
Description: Number of additional threads processing incoming client requests in the enclave (modify with care!) ,
Format: int32 ,
Required: False ,
}
integer ,
enclavePlatform:
{
Description: Enclave platform of the Confidential Ledger. ,
Enum:
{
IntelSgx: No description available. ,
AmdSevSnp: No description available. ,
}
,
Required: False ,
}
enum ,
applicationType:
{
Description: Application type of the Confidential Ledger. ,
Enum:
{
ConfidentialLedger: No description available. ,
CodeTransparency: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL the client should use to fetch the next page (per server side paging). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Ledger_ListBySubscription (new)
Description :  Retrieves the properties of all Confidential Ledgers.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ConfidentialLedger/ledgers/
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the list operation. eg. $filter=ledgerType eq 'Public' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Confidential Ledgers ,
Required: False ,
}
[
{
properties:
{
Description: Properties of Confidential Ledger Resource. ,
Required: False ,
}
{
ledgerName:
{
Description: Unique name for the Confidential Ledger. ,
Required: False ,
}
string ,
ledgerUri:
{
Description: Endpoint for calling Ledger Service. ,
Required: False ,
}
string ,
identityServiceUri:
{
Description: Endpoint for accessing network identity. ,
Required: False ,
}
string ,
ledgerInternalNamespace:
{
Description: Internal namespace for the Ledger ,
Required: False ,
}
string ,
runningState:
{
Description: Object representing RunningState for Ledger. ,
Enum:
{
Active: No description available. ,
Paused: No description available. ,
Unknown: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
}
,
Required: False ,
}
enum ,
ledgerType:
{
Description: Type of Confidential Ledger ,
Enum:
{
Unknown: No description available. ,
Public: No description available. ,
Private: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of Ledger Resource ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
ledgerSku:
{
Description: SKU associated with the ledger ,
Enum:
{
Standard: No description available. ,
Basic: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
aadBasedSecurityPrincipals:
{
Description: Array of all AAD based Security Principals. ,
Required: False ,
}
[
{
principalId:
{
Description: UUID/GUID based Principal Id of the Security Principal ,
Required: False ,
}
string ,
tenantId:
{
Description: UUID/GUID based Tenant Id of the Security Principal ,
Required: False ,
}
string ,
ledgerRoleName:
{
Description: LedgerRole associated with the Security Principal of Ledger ,
Enum:
{
Reader: No description available. ,
Contributor: No description available. ,
Administrator: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
certBasedSecurityPrincipals:
{
Description: Array of all cert based Security Principals. ,
Required: False ,
}
[
{
cert:
{
Description: Public key of the user cert (.pem or .cer) ,
Required: False ,
}
string ,
ledgerRoleName:
{
Description: LedgerRole associated with the Security Principal of Ledger ,
Enum:
{
Reader: No description available. ,
Contributor: No description available. ,
Administrator: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
hostLevel:
{
Description: CCF Property for the logging level for the untrusted host: Trace, Debug, Info, Fail, Fatal. ,
Required: False ,
}
string ,
maxBodySizeInMb:
{
Description: CCF Property for the maximum size of the http request body: 1MB, 5MB, 10MB. ,
Format: int32 ,
Required: False ,
}
integer ,
subjectName:
{
Description: CCF Property for the subject name to include in the node certificate. Default: CN=CCF Node. ,
Required: False ,
}
string ,
nodeCount:
{
Description: Number of CCF nodes in the ACC Ledger. ,
Format: int32 ,
Required: False ,
}
integer ,
writeLBAddressPrefix:
{
Description: Prefix for the write load balancer. Example: write ,
Required: False ,
}
string ,
workerThreads:
{
Description: Number of additional threads processing incoming client requests in the enclave (modify with care!) ,
Format: int32 ,
Required: False ,
}
integer ,
enclavePlatform:
{
Description: Enclave platform of the Confidential Ledger. ,
Enum:
{
IntelSgx: No description available. ,
AmdSevSnp: No description available. ,
}
,
Required: False ,
}
enum ,
applicationType:
{
Description: Application type of the Confidential Ledger. ,
Enum:
{
ConfidentialLedger: No description available. ,
CodeTransparency: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL the client should use to fetch the next page (per server side paging). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Ledger_Backup (new)
Description :  Backs up a Confidential Ledger Resource.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConfidentialLedger/ledgers/{ledgerName}/backup
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
ledgerName:
{
Description: Name of the Confidential Ledger ,
Required: True ,
}
string ,
confidentialLedger:
{
Description: Confidential Ledger Backup Request Body ,
Required: True ,
}
{
restoreRegion:
{
Description: The region where the backup of the ledger will eventually be restored to. ,
Required: False ,
}
string ,
uri:
{
Description: SAS URI used to access the backup Fileshare. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
message:
{
Description: Response body stating if the ledger is being backed up. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Ledger_Restore (new)
Description :  Restores a Confidential Ledger Resource.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConfidentialLedger/ledgers/{ledgerName}/restore
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
ledgerName:
{
Description: Name of the Confidential Ledger ,
Required: True ,
}
string ,
confidentialLedger:
{
Description: Confidential Ledger Restore Request Body ,
Required: True ,
}
{
fileShareName:
{
Description: Fileshare where the ledger backup is stored. ,
Required: True ,
}
string ,
restoreRegion:
{
Description: The region the ledger is being restored to. ,
Required: True ,
}
string ,
uri:
{
Description: SAS URI used to access the backup fileshare. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
message:
{
Description: Response body stating if the ledger is being restored. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedCCF_Get (new)
Description :  Retrieves the properties of a Managed CCF app.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConfidentialLedger/managedCCFs/{appName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
appName:
{
Description: Name of the Managed CCF ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of Managed CCF Resource. ,
Required: False ,
}
{
appName:
{
Description: Unique name for the Managed CCF. ,
Required: False ,
}
string ,
appUri:
{
Description: Endpoint for calling Managed CCF Service. ,
Required: False ,
}
string ,
identityServiceUri:
{
Description: Endpoint for accessing network identity. ,
Required: False ,
}
string ,
memberIdentityCertificates:
{
Description: List of member identity certificates for Managed CCF ,
Required: False ,
}
[
{
certificate:
{
Description: Member Identity Certificate ,
Required: False ,
}
string ,
encryptionkey:
{
Description: Member Identity Certificate Encryption Key ,
Required: False ,
}
string ,
tags:
{
Required: False ,
}
[
{
tags:
{
Description: Additional tags for Managed CCF Certificates ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
deploymentType:
{
Description: Deployment Type of Managed CCF ,
Required: False ,
}
{
languageRuntime:
{
Description: Unique name for the Managed CCF. ,
Enum:
{
CPP: No description available. ,
JS: No description available. ,
}
,
Required: False ,
}
enum ,
appSourceUri:
{
Description: Source Uri containing ManagedCCF code ,
Required: False ,
}
string ,
}
,
runningState:
{
Description: Object representing RunningState for Managed CCF. ,
Enum:
{
Active: No description available. ,
Paused: No description available. ,
Unknown: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of Managed CCF Resource ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
nodeCount:
{
Description: Number of CCF nodes in the Managed CCF. ,
Format: int32 ,
Required: False ,
}
integer ,
enclavePlatform:
{
Description: Enclave platform of Managed CCF. ,
Enum:
{
IntelSgx: No description available. ,
AmdSevSnp: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedCCF_Delete (new)
Description :  Deletes an existing Managed CCF.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConfidentialLedger/managedCCFs/{appName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
appName:
{
Description: Name of the Managed CCF ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedCCF_Create (new)
Description :  Creates a Managed CCF with the specified Managed CCF parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConfidentialLedger/managedCCFs/{appName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
appName:
{
Description: Name of the Managed CCF ,
Required: True ,
}
string ,
ManagedCCF:
{
Description: Managed CCF Create Request Body ,
Required: True ,
}
{
properties:
{
Description: Properties of Managed CCF Resource. ,
Required: False ,
}
{
appName:
{
Description: Unique name for the Managed CCF. ,
Required: False ,
}
string ,
appUri:
{
Description: Endpoint for calling Managed CCF Service. ,
Required: False ,
}
string ,
identityServiceUri:
{
Description: Endpoint for accessing network identity. ,
Required: False ,
}
string ,
memberIdentityCertificates:
{
Description: List of member identity certificates for Managed CCF ,
Required: False ,
}
[
{
certificate:
{
Description: Member Identity Certificate ,
Required: False ,
}
string ,
encryptionkey:
{
Description: Member Identity Certificate Encryption Key ,
Required: False ,
}
string ,
tags:
{
Required: False ,
}
[
{
tags:
{
Description: Additional tags for Managed CCF Certificates ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
deploymentType:
{
Description: Deployment Type of Managed CCF ,
Required: False ,
}
{
languageRuntime:
{
Description: Unique name for the Managed CCF. ,
Enum:
{
CPP: No description available. ,
JS: No description available. ,
}
,
Required: False ,
}
enum ,
appSourceUri:
{
Description: Source Uri containing ManagedCCF code ,
Required: False ,
}
string ,
}
,
runningState:
{
Description: Object representing RunningState for Managed CCF. ,
Enum:
{
Active: No description available. ,
Paused: No description available. ,
Unknown: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of Managed CCF Resource ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
nodeCount:
{
Description: Number of CCF nodes in the Managed CCF. ,
Format: int32 ,
Required: False ,
}
integer ,
enclavePlatform:
{
Description: Enclave platform of Managed CCF. ,
Enum:
{
IntelSgx: No description available. ,
AmdSevSnp: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of Managed CCF Resource. ,
Required: False ,
}
{
appName:
{
Description: Unique name for the Managed CCF. ,
Required: False ,
}
string ,
appUri:
{
Description: Endpoint for calling Managed CCF Service. ,
Required: False ,
}
string ,
identityServiceUri:
{
Description: Endpoint for accessing network identity. ,
Required: False ,
}
string ,
memberIdentityCertificates:
{
Description: List of member identity certificates for Managed CCF ,
Required: False ,
}
[
{
certificate:
{
Description: Member Identity Certificate ,
Required: False ,
}
string ,
encryptionkey:
{
Description: Member Identity Certificate Encryption Key ,
Required: False ,
}
string ,
tags:
{
Required: False ,
}
[
{
tags:
{
Description: Additional tags for Managed CCF Certificates ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
deploymentType:
{
Description: Deployment Type of Managed CCF ,
Required: False ,
}
{
languageRuntime:
{
Description: Unique name for the Managed CCF. ,
Enum:
{
CPP: No description available. ,
JS: No description available. ,
}
,
Required: False ,
}
enum ,
appSourceUri:
{
Description: Source Uri containing ManagedCCF code ,
Required: False ,
}
string ,
}
,
runningState:
{
Description: Object representing RunningState for Managed CCF. ,
Enum:
{
Active: No description available. ,
Paused: No description available. ,
Unknown: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of Managed CCF Resource ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
nodeCount:
{
Description: Number of CCF nodes in the Managed CCF. ,
Format: int32 ,
Required: False ,
}
integer ,
enclavePlatform:
{
Description: Enclave platform of Managed CCF. ,
Enum:
{
IntelSgx: No description available. ,
AmdSevSnp: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedCCF_Update (new)
Description :  Updates properties of Managed CCF
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConfidentialLedger/managedCCFs/{appName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
appName:
{
Description: Name of the Managed CCF ,
Required: True ,
}
string ,
ManagedCCF:
{
Description: Request body for Updating Managed CCF App ,
Required: True ,
}
{
properties:
{
Description: Properties of Managed CCF Resource. ,
Required: False ,
}
{
appName:
{
Description: Unique name for the Managed CCF. ,
Required: False ,
}
string ,
appUri:
{
Description: Endpoint for calling Managed CCF Service. ,
Required: False ,
}
string ,
identityServiceUri:
{
Description: Endpoint for accessing network identity. ,
Required: False ,
}
string ,
memberIdentityCertificates:
{
Description: List of member identity certificates for Managed CCF ,
Required: False ,
}
[
{
certificate:
{
Description: Member Identity Certificate ,
Required: False ,
}
string ,
encryptionkey:
{
Description: Member Identity Certificate Encryption Key ,
Required: False ,
}
string ,
tags:
{
Required: False ,
}
[
{
tags:
{
Description: Additional tags for Managed CCF Certificates ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
deploymentType:
{
Description: Deployment Type of Managed CCF ,
Required: False ,
}
{
languageRuntime:
{
Description: Unique name for the Managed CCF. ,
Enum:
{
CPP: No description available. ,
JS: No description available. ,
}
,
Required: False ,
}
enum ,
appSourceUri:
{
Description: Source Uri containing ManagedCCF code ,
Required: False ,
}
string ,
}
,
runningState:
{
Description: Object representing RunningState for Managed CCF. ,
Enum:
{
Active: No description available. ,
Paused: No description available. ,
Unknown: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of Managed CCF Resource ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
nodeCount:
{
Description: Number of CCF nodes in the Managed CCF. ,
Format: int32 ,
Required: False ,
}
integer ,
enclavePlatform:
{
Description: Enclave platform of Managed CCF. ,
Enum:
{
IntelSgx: No description available. ,
AmdSevSnp: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of Managed CCF Resource. ,
Required: False ,
}
{
appName:
{
Description: Unique name for the Managed CCF. ,
Required: False ,
}
string ,
appUri:
{
Description: Endpoint for calling Managed CCF Service. ,
Required: False ,
}
string ,
identityServiceUri:
{
Description: Endpoint for accessing network identity. ,
Required: False ,
}
string ,
memberIdentityCertificates:
{
Description: List of member identity certificates for Managed CCF ,
Required: False ,
}
[
{
certificate:
{
Description: Member Identity Certificate ,
Required: False ,
}
string ,
encryptionkey:
{
Description: Member Identity Certificate Encryption Key ,
Required: False ,
}
string ,
tags:
{
Required: False ,
}
[
{
tags:
{
Description: Additional tags for Managed CCF Certificates ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
deploymentType:
{
Description: Deployment Type of Managed CCF ,
Required: False ,
}
{
languageRuntime:
{
Description: Unique name for the Managed CCF. ,
Enum:
{
CPP: No description available. ,
JS: No description available. ,
}
,
Required: False ,
}
enum ,
appSourceUri:
{
Description: Source Uri containing ManagedCCF code ,
Required: False ,
}
string ,
}
,
runningState:
{
Description: Object representing RunningState for Managed CCF. ,
Enum:
{
Active: No description available. ,
Paused: No description available. ,
Unknown: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of Managed CCF Resource ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
nodeCount:
{
Description: Number of CCF nodes in the Managed CCF. ,
Format: int32 ,
Required: False ,
}
integer ,
enclavePlatform:
{
Description: Enclave platform of Managed CCF. ,
Enum:
{
IntelSgx: No description available. ,
AmdSevSnp: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedCCF_ListByResourceGroup (new)
Description :  Retrieves the properties of all Managed CCF apps.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConfidentialLedger/managedCCFs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the list operation. eg. $filter=ledgerType eq 'Public' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Managed CCF ,
Required: False ,
}
[
{
properties:
{
Description: Properties of Managed CCF Resource. ,
Required: False ,
}
{
appName:
{
Description: Unique name for the Managed CCF. ,
Required: False ,
}
string ,
appUri:
{
Description: Endpoint for calling Managed CCF Service. ,
Required: False ,
}
string ,
identityServiceUri:
{
Description: Endpoint for accessing network identity. ,
Required: False ,
}
string ,
memberIdentityCertificates:
{
Description: List of member identity certificates for Managed CCF ,
Required: False ,
}
[
{
certificate:
{
Description: Member Identity Certificate ,
Required: False ,
}
string ,
encryptionkey:
{
Description: Member Identity Certificate Encryption Key ,
Required: False ,
}
string ,
tags:
{
Required: False ,
}
[
{
tags:
{
Description: Additional tags for Managed CCF Certificates ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
deploymentType:
{
Description: Deployment Type of Managed CCF ,
Required: False ,
}
{
languageRuntime:
{
Description: Unique name for the Managed CCF. ,
Enum:
{
CPP: No description available. ,
JS: No description available. ,
}
,
Required: False ,
}
enum ,
appSourceUri:
{
Description: Source Uri containing ManagedCCF code ,
Required: False ,
}
string ,
}
,
runningState:
{
Description: Object representing RunningState for Managed CCF. ,
Enum:
{
Active: No description available. ,
Paused: No description available. ,
Unknown: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of Managed CCF Resource ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
nodeCount:
{
Description: Number of CCF nodes in the Managed CCF. ,
Format: int32 ,
Required: False ,
}
integer ,
enclavePlatform:
{
Description: Enclave platform of Managed CCF. ,
Enum:
{
IntelSgx: No description available. ,
AmdSevSnp: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL the client should use to fetch the next page (per server side paging). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedCCF_ListBySubscription (new)
Description :  Retrieves the properties of all Managed CCF.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ConfidentialLedger/managedCCFs/
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the list operation. eg. $filter=ledgerType eq 'Public' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Managed CCF ,
Required: False ,
}
[
{
properties:
{
Description: Properties of Managed CCF Resource. ,
Required: False ,
}
{
appName:
{
Description: Unique name for the Managed CCF. ,
Required: False ,
}
string ,
appUri:
{
Description: Endpoint for calling Managed CCF Service. ,
Required: False ,
}
string ,
identityServiceUri:
{
Description: Endpoint for accessing network identity. ,
Required: False ,
}
string ,
memberIdentityCertificates:
{
Description: List of member identity certificates for Managed CCF ,
Required: False ,
}
[
{
certificate:
{
Description: Member Identity Certificate ,
Required: False ,
}
string ,
encryptionkey:
{
Description: Member Identity Certificate Encryption Key ,
Required: False ,
}
string ,
tags:
{
Required: False ,
}
[
{
tags:
{
Description: Additional tags for Managed CCF Certificates ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
deploymentType:
{
Description: Deployment Type of Managed CCF ,
Required: False ,
}
{
languageRuntime:
{
Description: Unique name for the Managed CCF. ,
Enum:
{
CPP: No description available. ,
JS: No description available. ,
}
,
Required: False ,
}
enum ,
appSourceUri:
{
Description: Source Uri containing ManagedCCF code ,
Required: False ,
}
string ,
}
,
runningState:
{
Description: Object representing RunningState for Managed CCF. ,
Enum:
{
Active: No description available. ,
Paused: No description available. ,
Unknown: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of Managed CCF Resource ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
nodeCount:
{
Description: Number of CCF nodes in the Managed CCF. ,
Format: int32 ,
Required: False ,
}
integer ,
enclavePlatform:
{
Description: Enclave platform of Managed CCF. ,
Enum:
{
IntelSgx: No description available. ,
AmdSevSnp: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL the client should use to fetch the next page (per server side paging). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedCCF_Backup (new)
Description :  Backs up a Managed CCF Resource.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConfidentialLedger/managedCCFs/{appName}/backup
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
appName:
{
Description: Name of the Managed CCF ,
Required: True ,
}
string ,
ManagedCCF:
{
Description: Managed CCF Backup Request Body ,
Required: True ,
}
{
restoreRegion:
{
Description: The region where the backup of the managed CCF resource will eventually be restored to. ,
Required: False ,
}
string ,
uri:
{
Description: SAS URI used to access the backup Fileshare. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
message:
{
Description: Response body stating if the managed CCF resource is being backed up. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedCCF_Restore (new)
Description :  Restores a Managed CCF Resource.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConfidentialLedger/managedCCFs/{appName}/restore
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
appName:
{
Description: Name of the Managed CCF ,
Required: True ,
}
string ,
ManagedCCF:
{
Description: Managed CCF Restore Request Body ,
Required: True ,
}
{
fileShareName:
{
Description: Fileshare where the managed CCF resource backup is stored. ,
Required: True ,
}
string ,
restoreRegion:
{
Description: The region the managed CCF resource is being restored to. ,
Required: True ,
}
string ,
uri:
{
Description: SAS URI used to access the backup Fileshare. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
message:
{
Description: Response body stating if the managed CCF resource is being restored. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}