Endpoint Certificates - List By Instance

Service:: SQL Database

API Version:: 2023-08-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=2023-08-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	ErrorResponse	* Error Responses: * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription. 404 SubscriptionDoesNotHaveServer - The requested server was not found

Name

Type

Description

200 OK

EndpointCertificateListResult

Successfully retrieved a list of endpoint certificates.

Other Status Codes

ErrorResponse

*** Error Responses: ***

400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state
400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state
404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.
404 SubscriptionDoesNotHaveServer - The requested server was not found

Examples

Get a list of endpoint certificates.

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/EndpointCertificatesListByInstance.json
// this example is just showing the usage of "EndpointCertificates_ListByInstance" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ManagedInstanceResource created on azure
// for more information of creating ManagedInstanceResource, please refer to the document of ManagedInstanceResource
string subscriptionId = "38e0dc56-907f-45ba-a97c-74233baad471";
string resourceGroupName = "testrg";
string managedInstanceName = "testcl";
ResourceIdentifier managedInstanceResourceId = ManagedInstanceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, managedInstanceName);
ManagedInstanceResource managedInstance = client.GetManagedInstanceResource(managedInstanceResourceId);

// get the collection of this EndpointCertificateResource
EndpointCertificateCollection collection = managedInstance.GetEndpointCertificates();

// invoke the operation and iterate over the result
await foreach (EndpointCertificateResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    EndpointCertificateData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response

EndpointCertificate

Object

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

Object

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.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

Share via

Endpoint Certificates - List By Instance

URI Parameters

Responses

Examples

Get a list of endpoint certificates.

Sample request

Sample response

Definitions

EndpointCertificate

EndpointCertificateListResult

ErrorAdditionalInfo

ErrorDetail

ErrorResponse