endpoint_certificates
Creates, updates, deletes, gets or lists an endpoint_certificates resource.
Overview
| Name | endpoint_certificates |
| Type | Resource |
| Id | azure.sql.endpoint_certificates |
Fields
The following fields are returned by SELECT queries:
- get
- list_by_instance
| Name | Datatype | Description |
|---|---|---|
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. |
publicBlob | string | The certificate public blob. |
systemData | object | 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". |
| Name | Datatype | Description |
|---|---|---|
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. |
publicBlob | string | The certificate public blob. |
systemData | object | 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". |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | resource_group_name, managed_instance_name, endpoint_type, subscription_id | Gets a certificate used on the endpoint with the given id. | |
list_by_instance | select | resource_group_name, managed_instance_name, subscription_id | List certificates used on endpoints on the target instance. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
endpoint_type | string | Type of the endpoint whose certificate the customer is looking for. Required. |
managed_instance_name | string | The name of the managed instance. Required. |
resource_group_name | string | The name of the resource group. The name is case insensitive. Required. |
subscription_id | string |
SELECT examples
- get
- list_by_instance
Gets a certificate used on the endpoint with the given id.
SELECT
id,
name,
publicBlob,
systemData,
type
FROM azure.sql.endpoint_certificates
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND managed_instance_name = '{{ managed_instance_name }}' -- required
AND endpoint_type = '{{ endpoint_type }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;
List certificates used on endpoints on the target instance.
SELECT
id,
name,
publicBlob,
systemData,
type
FROM azure.sql.endpoint_certificates
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND managed_instance_name = '{{ managed_instance_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;