1. Packages
  2. Azure Native
  3. API Docs
  4. apimanagement
  5. getCertificate
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

azure-native.apimanagement.getCertificate

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

    Gets the details of the certificate specified by its identifier. Azure REST API version: 2022-08-01.

    Other available API versions: 2016-07-07, 2016-10-10, 2022-09-01-preview, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01.

    Using getCertificate

    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 getCertificate(args: GetCertificateArgs, opts?: InvokeOptions): Promise<GetCertificateResult>
    function getCertificateOutput(args: GetCertificateOutputArgs, opts?: InvokeOptions): Output<GetCertificateResult>
    def get_certificate(certificate_id: Optional[str] = None,
                        resource_group_name: Optional[str] = None,
                        service_name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetCertificateResult
    def get_certificate_output(certificate_id: Optional[pulumi.Input[str]] = None,
                        resource_group_name: Optional[pulumi.Input[str]] = None,
                        service_name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetCertificateResult]
    func LookupCertificate(ctx *Context, args *LookupCertificateArgs, opts ...InvokeOption) (*LookupCertificateResult, error)
    func LookupCertificateOutput(ctx *Context, args *LookupCertificateOutputArgs, opts ...InvokeOption) LookupCertificateResultOutput

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

    public static class GetCertificate 
    {
        public static Task<GetCertificateResult> InvokeAsync(GetCertificateArgs args, InvokeOptions? opts = null)
        public static Output<GetCertificateResult> Invoke(GetCertificateInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetCertificateResult> getCertificate(GetCertificateArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:apimanagement:getCertificate
      arguments:
        # arguments dictionary

    The following arguments are supported:

    CertificateId string
    Identifier of the certificate entity. Must be unique in the current API Management service instance.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServiceName string
    The name of the API Management service.
    CertificateId string
    Identifier of the certificate entity. Must be unique in the current API Management service instance.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServiceName string
    The name of the API Management service.
    certificateId String
    Identifier of the certificate entity. Must be unique in the current API Management service instance.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serviceName String
    The name of the API Management service.
    certificateId string
    Identifier of the certificate entity. Must be unique in the current API Management service instance.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    serviceName string
    The name of the API Management service.
    certificate_id str
    Identifier of the certificate entity. Must be unique in the current API Management service instance.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    service_name str
    The name of the API Management service.
    certificateId String
    Identifier of the certificate entity. Must be unique in the current API Management service instance.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serviceName String
    The name of the API Management service.

    getCertificate Result

    The following output properties are available:

    ExpirationDate string
    Expiration date of the certificate. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Name string
    The name of the resource
    Subject string
    Subject attribute of the certificate.
    Thumbprint string
    Thumbprint of the certificate.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    KeyVault Pulumi.AzureNative.ApiManagement.Outputs.KeyVaultContractPropertiesResponse
    KeyVault location details of the certificate.
    ExpirationDate string
    Expiration date of the certificate. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Name string
    The name of the resource
    Subject string
    Subject attribute of the certificate.
    Thumbprint string
    Thumbprint of the certificate.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    KeyVault KeyVaultContractPropertiesResponse
    KeyVault location details of the certificate.
    expirationDate String
    Expiration date of the certificate. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name String
    The name of the resource
    subject String
    Subject attribute of the certificate.
    thumbprint String
    Thumbprint of the certificate.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    keyVault KeyVaultContractPropertiesResponse
    KeyVault location details of the certificate.
    expirationDate string
    Expiration date of the certificate. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
    id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name string
    The name of the resource
    subject string
    Subject attribute of the certificate.
    thumbprint string
    Thumbprint of the certificate.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    keyVault KeyVaultContractPropertiesResponse
    KeyVault location details of the certificate.
    expiration_date str
    Expiration date of the certificate. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
    id str
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name str
    The name of the resource
    subject str
    Subject attribute of the certificate.
    thumbprint str
    Thumbprint of the certificate.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    key_vault KeyVaultContractPropertiesResponse
    KeyVault location details of the certificate.
    expirationDate String
    Expiration date of the certificate. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name String
    The name of the resource
    subject String
    Subject attribute of the certificate.
    thumbprint String
    Thumbprint of the certificate.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    keyVault Property Map
    KeyVault location details of the certificate.

    Supporting Types

    KeyVaultContractPropertiesResponse

    IdentityClientId string
    Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret.
    LastStatus Pulumi.AzureNative.ApiManagement.Inputs.KeyVaultLastAccessStatusContractPropertiesResponse
    Last time sync and refresh status of secret from key vault.
    SecretIdentifier string
    Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires API Management service to be configured with aka.ms/apimmsi
    IdentityClientId string
    Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret.
    LastStatus KeyVaultLastAccessStatusContractPropertiesResponse
    Last time sync and refresh status of secret from key vault.
    SecretIdentifier string
    Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires API Management service to be configured with aka.ms/apimmsi
    identityClientId String
    Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret.
    lastStatus KeyVaultLastAccessStatusContractPropertiesResponse
    Last time sync and refresh status of secret from key vault.
    secretIdentifier String
    Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires API Management service to be configured with aka.ms/apimmsi
    identityClientId string
    Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret.
    lastStatus KeyVaultLastAccessStatusContractPropertiesResponse
    Last time sync and refresh status of secret from key vault.
    secretIdentifier string
    Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires API Management service to be configured with aka.ms/apimmsi
    identity_client_id str
    Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret.
    last_status KeyVaultLastAccessStatusContractPropertiesResponse
    Last time sync and refresh status of secret from key vault.
    secret_identifier str
    Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires API Management service to be configured with aka.ms/apimmsi
    identityClientId String
    Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret.
    lastStatus Property Map
    Last time sync and refresh status of secret from key vault.
    secretIdentifier String
    Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires API Management service to be configured with aka.ms/apimmsi

    KeyVaultLastAccessStatusContractPropertiesResponse

    Code string
    Last status code for sync and refresh of secret from key vault.
    Message string
    Details of the error else empty.
    TimeStampUtc string
    Last time secret was accessed. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
    Code string
    Last status code for sync and refresh of secret from key vault.
    Message string
    Details of the error else empty.
    TimeStampUtc string
    Last time secret was accessed. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
    code String
    Last status code for sync and refresh of secret from key vault.
    message String
    Details of the error else empty.
    timeStampUtc String
    Last time secret was accessed. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
    code string
    Last status code for sync and refresh of secret from key vault.
    message string
    Details of the error else empty.
    timeStampUtc string
    Last time secret was accessed. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
    code str
    Last status code for sync and refresh of secret from key vault.
    message str
    Details of the error else empty.
    time_stamp_utc str
    Last time secret was accessed. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
    code String
    Last status code for sync and refresh of secret from key vault.
    message String
    Details of the error else empty.
    timeStampUtc String
    Last time secret was accessed. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

    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 v1 docs if using the v1 version of this package.
    Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi