Endpoint Certificates - List By Instance

Service:

SQL Database

API Version:

2021-11-01

List certificates used on endpoints on the target instance.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/endpointCertificates?api-version=2021-11-01

URI Parameters

Name	In	Required	Type	Description
managedInstanceName	path	True	string	The name of the managed instance.
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.
subscriptionId	path	True	string	The subscription ID that identifies an Azure subscription.
api-version	query	True	string	The API version to use for the request.

Responses

Name	Type	Description
200 OK	EndpointCertificateListResult	Successfully retrieved a list of endpoint certificates.
Other Status Codes		*** Error Responses: *** 404 SubscriptionDoesNotHaveServer - The requested server was not found 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.

Examples

Get a list of endpoint certificates.

Sample Request

HTTP

GET https://management.azure.com/subscriptions/38e0dc56-907f-45ba-a97c-74233baad471/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testcl/endpointCertificates?api-version=2021-11-01

Java

import com.azure.core.util.Context;

/** Samples for EndpointCertificates ListByInstance. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/EndpointCertificatesListByInstance.
     * json
     */
    /**
     * Sample code: Get a list of endpoint certificates.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getAListOfEndpointCertificates(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getEndpointCertificates().listByInstance("testrg", "testcl",
            Context.NONE);
    }
}

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

Sample Response

Status code:

200

{
  "value": [
    {
      "properties": {
        "publicBlob": "0x308203B23082021AA003020102021034C597BA"
      },
      "id": "/subscriptions/38e0dc56-907f-45ba-a97c-74233baad471/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testcl/endpointCertificates/SERVICE_BROKER",
      "name": "SERVICE_BROKER",
      "type": "Microsoft.Sql/managedInstances/endpointCertificates"
    },
    {
      "properties": {
        "publicBlob": "0x308203B23082021AA003020102021034C597BA"
      },
      "id": "/subscriptions/38e0dc56-907f-45ba-a97c-74233baad471/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testcl/endpointCertificates/DATABASE_MIRRORING",
      "name": "DATABASE_MIRRORING",
      "type": "Microsoft.Sql/managedInstances/endpointCertificates"
    }
  ]
}

Definitions

Name	Description
EndpointCertificate	Certificate used on an endpoint on the Managed Instance.
EndpointCertificateListResult	A list of endpoint certificates on the target instance.

EndpointCertificate

Certificate used on an endpoint on the Managed Instance.

Name	Type	Description
id	string	Resource ID.
name	string	Resource name.
properties.publicBlob	string	The certificate public blob
type	string	Resource type.

EndpointCertificateListResult

A list of endpoint certificates on the target instance.

Name	Type	Description
nextLink	string	Link to retrieve next page of results.
value	EndpointCertificate[]	Array of results.