Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. confidentialledger
  5. getLedger
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.confidentialledger.getLedger

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

    Retrieves the properties of a Confidential Ledger.

    Uses Azure REST API version 2023-06-28-preview.

    Other available API versions: 2022-05-13, 2022-09-08-preview, 2023-01-26-preview, 2024-07-09-preview, 2024-09-19-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native confidentialledger [ApiVersion]. See the version guide for details.

    Using getLedger

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getLedger(args: GetLedgerArgs, opts?: InvokeOptions): Promise<GetLedgerResult>
function getLedgerOutput(args: GetLedgerOutputArgs, opts?: InvokeOptions): Output<GetLedgerResult>
    def get_ledger(ledger_name: Optional[str] = None,
               resource_group_name: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetLedgerResult
def get_ledger_output(ledger_name: Optional[pulumi.Input[str]] = None,
               resource_group_name: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetLedgerResult]
    func LookupLedger(ctx *Context, args *LookupLedgerArgs, opts ...InvokeOption) (*LookupLedgerResult, error)
func LookupLedgerOutput(ctx *Context, args *LookupLedgerOutputArgs, opts ...InvokeOption) LookupLedgerResultOutput

    > Note: This function is named LookupLedger in the Go SDK.

    public static class GetLedger 
{
    public static Task<GetLedgerResult> InvokeAsync(GetLedgerArgs args, InvokeOptions? opts = null)
    public static Output<GetLedgerResult> Invoke(GetLedgerInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetLedgerResult> getLedger(GetLedgerArgs args, InvokeOptions options)
public static Output<GetLedgerResult> getLedger(GetLedgerArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:confidentialledger:getLedger
  arguments:
    # arguments dictionary

    The following arguments are supported:

    LedgerName string
    Name of the Confidential Ledger
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    LedgerName string
    Name of the Confidential Ledger
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ledgerName String
    Name of the Confidential Ledger
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    ledgerName string
    Name of the Confidential Ledger
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    ledger_name str
    Name of the Confidential Ledger
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    ledgerName String
    Name of the Confidential Ledger
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getLedger Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    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 Pulumi.AzureNative.ConfidentialLedger.Outputs.LedgerPropertiesResponse
    Properties of Confidential Ledger Resource.
    SystemData Pulumi.AzureNative.ConfidentialLedger.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Tags Dictionary<string, string>
    Resource tags.
    AzureApiVersion string
    The Azure API version of the resource.
    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 LedgerPropertiesResponse
    Properties of Confidential Ledger Resource.
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Tags map[string]string
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    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 LedgerPropertiesResponse
    Properties of Confidential Ledger Resource.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    tags Map<String,String>
    Resource tags.
    azureApiVersion string
    The Azure API version of the resource.
    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 LedgerPropertiesResponse
    Properties of Confidential Ledger Resource.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    tags {[key: string]: string}
    Resource tags.
    azure_api_version str
    The Azure API version of the resource.
    id str
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    properties LedgerPropertiesResponse
    Properties of Confidential Ledger Resource.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    tags Mapping[str, str]
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    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 Property Map
    Properties of Confidential Ledger Resource.
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    tags Map<String>
    Resource tags.

    Supporting Types

    AADBasedSecurityPrincipalResponse

    LedgerRoleName string
    LedgerRole associated with the Security Principal of Ledger
    PrincipalId string
    UUID/GUID based Principal Id of the Security Principal
    TenantId string
    UUID/GUID based Tenant Id of the Security Principal
    LedgerRoleName string
    LedgerRole associated with the Security Principal of Ledger
    PrincipalId string
    UUID/GUID based Principal Id of the Security Principal
    TenantId string
    UUID/GUID based Tenant Id of the Security Principal
    ledgerRoleName String
    LedgerRole associated with the Security Principal of Ledger
    principalId String
    UUID/GUID based Principal Id of the Security Principal
    tenantId String
    UUID/GUID based Tenant Id of the Security Principal
    ledgerRoleName string
    LedgerRole associated with the Security Principal of Ledger
    principalId string
    UUID/GUID based Principal Id of the Security Principal
    tenantId string
    UUID/GUID based Tenant Id of the Security Principal
    ledger_role_name str
    LedgerRole associated with the Security Principal of Ledger
    principal_id str
    UUID/GUID based Principal Id of the Security Principal
    tenant_id str
    UUID/GUID based Tenant Id of the Security Principal
    ledgerRoleName String
    LedgerRole associated with the Security Principal of Ledger
    principalId String
    UUID/GUID based Principal Id of the Security Principal
    tenantId String
    UUID/GUID based Tenant Id of the Security Principal

    CertBasedSecurityPrincipalResponse

    Cert string
    Public key of the user cert (.pem or .cer)
    LedgerRoleName string
    LedgerRole associated with the Security Principal of Ledger
    Cert string
    Public key of the user cert (.pem or .cer)
    LedgerRoleName string
    LedgerRole associated with the Security Principal of Ledger
    cert String
    Public key of the user cert (.pem or .cer)
    ledgerRoleName String
    LedgerRole associated with the Security Principal of Ledger
    cert string
    Public key of the user cert (.pem or .cer)
    ledgerRoleName string
    LedgerRole associated with the Security Principal of Ledger
    cert str
    Public key of the user cert (.pem or .cer)
    ledger_role_name str
    LedgerRole associated with the Security Principal of Ledger
    cert String
    Public key of the user cert (.pem or .cer)
    ledgerRoleName String
    LedgerRole associated with the Security Principal of Ledger

    LedgerPropertiesResponse

    IdentityServiceUri string
    Endpoint for accessing network identity.
    LedgerInternalNamespace string
    Internal namespace for the Ledger
    LedgerName string
    Unique name for the Confidential Ledger.
    LedgerUri string
    Endpoint for calling Ledger Service.
    ProvisioningState string
    Provisioning state of Ledger Resource
    AadBasedSecurityPrincipals List<Pulumi.AzureNative.ConfidentialLedger.Inputs.AADBasedSecurityPrincipalResponse>
    Array of all AAD based Security Principals.
    CertBasedSecurityPrincipals List<Pulumi.AzureNative.ConfidentialLedger.Inputs.CertBasedSecurityPrincipalResponse>
    Array of all cert based Security Principals.
    LedgerSku string
    SKU associated with the ledger
    LedgerType string
    Type of Confidential Ledger
    RunningState string
    Object representing RunningState for Ledger.
    IdentityServiceUri string
    Endpoint for accessing network identity.
    LedgerInternalNamespace string
    Internal namespace for the Ledger
    LedgerName string
    Unique name for the Confidential Ledger.
    LedgerUri string
    Endpoint for calling Ledger Service.
    ProvisioningState string
    Provisioning state of Ledger Resource
    AadBasedSecurityPrincipals []AADBasedSecurityPrincipalResponse
    Array of all AAD based Security Principals.
    CertBasedSecurityPrincipals []CertBasedSecurityPrincipalResponse
    Array of all cert based Security Principals.
    LedgerSku string
    SKU associated with the ledger
    LedgerType string
    Type of Confidential Ledger
    RunningState string
    Object representing RunningState for Ledger.
    identityServiceUri String
    Endpoint for accessing network identity.
    ledgerInternalNamespace String
    Internal namespace for the Ledger
    ledgerName String
    Unique name for the Confidential Ledger.
    ledgerUri String
    Endpoint for calling Ledger Service.
    provisioningState String
    Provisioning state of Ledger Resource
    aadBasedSecurityPrincipals List<AADBasedSecurityPrincipalResponse>
    Array of all AAD based Security Principals.
    certBasedSecurityPrincipals List<CertBasedSecurityPrincipalResponse>
    Array of all cert based Security Principals.
    ledgerSku String
    SKU associated with the ledger
    ledgerType String
    Type of Confidential Ledger
    runningState String
    Object representing RunningState for Ledger.
    identityServiceUri string
    Endpoint for accessing network identity.
    ledgerInternalNamespace string
    Internal namespace for the Ledger
    ledgerName string
    Unique name for the Confidential Ledger.
    ledgerUri string
    Endpoint for calling Ledger Service.
    provisioningState string
    Provisioning state of Ledger Resource
    aadBasedSecurityPrincipals AADBasedSecurityPrincipalResponse[]
    Array of all AAD based Security Principals.
    certBasedSecurityPrincipals CertBasedSecurityPrincipalResponse[]
    Array of all cert based Security Principals.
    ledgerSku string
    SKU associated with the ledger
    ledgerType string
    Type of Confidential Ledger
    runningState string
    Object representing RunningState for Ledger.
    identity_service_uri str
    Endpoint for accessing network identity.
    ledger_internal_namespace str
    Internal namespace for the Ledger
    ledger_name str
    Unique name for the Confidential Ledger.
    ledger_uri str
    Endpoint for calling Ledger Service.
    provisioning_state str
    Provisioning state of Ledger Resource
    aad_based_security_principals Sequence[AADBasedSecurityPrincipalResponse]
    Array of all AAD based Security Principals.
    cert_based_security_principals Sequence[CertBasedSecurityPrincipalResponse]
    Array of all cert based Security Principals.
    ledger_sku str
    SKU associated with the ledger
    ledger_type str
    Type of Confidential Ledger
    running_state str
    Object representing RunningState for Ledger.
    identityServiceUri String
    Endpoint for accessing network identity.
    ledgerInternalNamespace String
    Internal namespace for the Ledger
    ledgerName String
    Unique name for the Confidential Ledger.
    ledgerUri String
    Endpoint for calling Ledger Service.
    provisioningState String
    Provisioning state of Ledger Resource
    aadBasedSecurityPrincipals List<Property Map>
    Array of all AAD based Security Principals.
    certBasedSecurityPrincipals List<Property Map>
    Array of all cert based Security Principals.
    ledgerSku String
    SKU associated with the ledger
    ledgerType String
    Type of Confidential Ledger
    runningState String
    Object representing RunningState for Ledger.

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
    pulumi/pulumi-azure-native