Certificates - Get

Get the certificate resource.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/certificates/{certificateName}?api-version=2019-05-01-preview

URI Parameters

Name In Required Type Description
certificateName
path True
  • string

The name of the certificate resource.

resourceGroupName
path True
  • string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serviceName
path True
  • string

The name of the Service resource.

subscriptionId
path True
  • string

Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

api-version
query True
  • string

Client Api Version.

Responses

Name Type Description
200 OK

Success. The response describe the certificate.

Other Status Codes

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Certificates_Get

Sample Request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycertificate?api-version=2019-05-01-preview

Sample Response

{
  "properties": {
    "thumbprint": "934367bf1c97033f877db0f15cb1b586957d3133",
    "vaultUri": "https://myvault.vault.azure.net",
    "keyVaultCertName": "mycert",
    "certVersion": "08a219d06d874795a96db47e06fbb01e",
    "issuer": "mydomain.com",
    "issuedDate": "2019-02-20T07:40:42Z",
    "expirationDate": "2019-02-21T07:40:42Z",
    "activateDate": "2019-02-22T07:40:42Z",
    "subjectName": "mysubjectname",
    "dnsNames": [
      "mydomain.com",
      "mydomain.net",
      "mydomain.io"
    ]
  },
  "type": "Microsoft.AppPlatform/Spring/certificates",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycertificate",
  "name": "mycertificate"
}

Definitions

CertificateProperties

Certificate resource payload.

CertificateResource

Certificate resource payload.

CloudError

An error response from the service.

CloudErrorBody

An error response from the service.

CertificateProperties

Certificate resource payload.

Name Type Description
activateDate
  • string

The activate date of certificate.

certVersion
  • string

The certificate version of key vault.

dnsNames
  • string[]

The domain list of certificate.

expirationDate
  • string

The expiration date of certificate.

issuedDate
  • string

The issue date of certificate.

issuer
  • string

The issuer of certificate.

keyVaultCertName
  • string

The certificate name of key vault.

subjectName
  • string

The subject name of certificate.

thumbprint
  • string

The thumbprint of certificate.

vaultUri
  • string

The vault uri of user key vault.

CertificateResource

Certificate resource payload.

Name Type Description
id
  • string

Fully qualified resource Id for the resource.

name
  • string

The name of the resource.

properties

Properties of the certificate resource payload.

type
  • string

The type of the resource.

CloudError

An error response from the service.

Name Type Description
error

An error response from the service.

CloudErrorBody

An error response from the service.

Name Type Description
code
  • string

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

details

A list of additional details about the error.

message
  • string

A message describing the error, intended to be suitable for display in a user interface.

target
  • string

The target of the particular error. For example, the name of the property in error.