server_trust_certificates

Creates, updates, deletes, gets or lists a server_trust_certificates resource.

Overview

Name	server_trust_certificates
Type	Resource
Id	azure.sql.server_trust_certificates

Fields

The following fields are returned by SELECT queries:

get

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.
certificateName	string	The certificate name.
publicBlob	string	The certificate public blob.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
thumbprint	string	The certificate thumbprint.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

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.
certificateName	string	The certificate name.
publicBlob	string	The certificate public blob.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
thumbprint	string	The certificate thumbprint.
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, certificate_name, subscription_id		Gets a server trust certificate that was uploaded from SQL Server to SQL Managed Instance.
list_by_instance	select	resource_group_name, managed_instance_name, subscription_id		Gets a list of the server trust certificates used to secure communication between SQL Server and the specified SQL Managed Instance.
create_or_update	insert	resource_group_name, managed_instance_name, certificate_name, subscription_id		Uploads a server trust certificate from SQL Server to SQL Managed Instance.
create_or_update	replace	resource_group_name, managed_instance_name, certificate_name, subscription_id		Uploads a server trust certificate from SQL Server to SQL Managed Instance.
delete	delete	resource_group_name, managed_instance_name, certificate_name, subscription_id		Deletes a server trust certificate that was uploaded from SQL Server to SQL Managed 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
certificate_name	string	Name of of the certificate to get. 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

Gets a server trust certificate that was uploaded from SQL Server to SQL Managed Instance.

SELECT
id,
name,
certificateName,
publicBlob,
systemData,
thumbprint,
type
FROM azure.sql.server_trust_certificates
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND managed_instance_name = '{{ managed_instance_name }}' -- required
AND certificate_name = '{{ certificate_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_instance

Gets a list of the server trust certificates used to secure communication between SQL Server and the specified SQL Managed Instance.

SELECT
id,
name,
certificateName,
publicBlob,
systemData,
thumbprint,
type
FROM azure.sql.server_trust_certificates
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND managed_instance_name = '{{ managed_instance_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Uploads a server trust certificate from SQL Server to SQL Managed Instance.

INSERT INTO azure.sql.server_trust_certificates (
properties,
resource_group_name,
managed_instance_name,
certificate_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ managed_instance_name }}',
'{{ certificate_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: server_trust_certificates
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the server_trust_certificates resource.
  - name: managed_instance_name
    value: "{{ managed_instance_name }}"
    description: Required parameter for the server_trust_certificates resource.
  - name: certificate_name
    value: "{{ certificate_name }}"
    description: Required parameter for the server_trust_certificates resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the server_trust_certificates resource.
  - name: properties
    description: |
      Resource properties.
    value:
      publicBlob: "{{ publicBlob }}"
      thumbprint: "{{ thumbprint }}"
      certificateName: "{{ certificateName }}"

REPLACE examples

create_or_update

Uploads a server trust certificate from SQL Server to SQL Managed Instance.

REPLACE azure.sql.server_trust_certificates
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND managed_instance_name = '{{ managed_instance_name }}' --required
AND certificate_name = '{{ certificate_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes a server trust certificate that was uploaded from SQL Server to SQL Managed Instance.

DELETE FROM azure.sql.server_trust_certificates
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND managed_instance_name = '{{ managed_instance_name }}' --required
AND certificate_name = '{{ certificate_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;