Skip to content

Commit 681c721

Browse files
Merge pull request #227387 from dnethi/docs-editor/privacy-data-collection-and-re-1676424920
Updated to add JSON structures for Arc Data controller and Arc SQL MI
2 parents 4bbbc1c + 77fe80b commit 681c721

File tree

1 file changed

+340
-3
lines changed

1 file changed

+340
-3
lines changed

articles/azure-arc/data/privacy-data-collection-and-reporting.md

Lines changed: 340 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -198,8 +198,157 @@ The following JSON document is an example of the SQL Server database - Azure Arc
198198
- Last uploaded date from on-premises cluster.
199199
- `System.DateTime: LastUploadedDate`
200200
- Data controller state
201-
- `string: ProvisioningState`
201+
- `string: ProvisioningState`
202+
203+
204+
The following JSON document is an example of the Azure Arc Data Controller resource.
205+
206+
202207

208+
```json
209+
{
210+
"id": "/subscriptions/7894901a-dfga-rf4d-85r4-cc1234459df2/resourceGroups/contoso-rg/providers/Microsoft.AzureArcData/dataControllers/contosodc",
211+
"name": "contosodc",
212+
"type": "microsoft.azurearcdata/datacontrollers",
213+
"location": "eastus",
214+
"extendedLocation": {
215+
"name": "/subscriptions/7894901a-dfga-rf4d-85r4-cc1234459df2/resourceGroups/contoso-rg/providers/Microsoft.ExtendedLocation/customLocations/contoso",
216+
"type": "CustomLocation"
217+
},
218+
"tags": {},
219+
"systemData": {
220+
"createdBy": "[email protected]",
221+
"createdByType": "User",
222+
"createdAt": "2023-01-03T21:35:36.8412132Z",
223+
"lastModifiedBy": "319f651f-7ddb-4fc6-9857-7aef9250bd05",
224+
"lastModifiedByType": "Application",
225+
"lastModifiedAt": "2023-02-15T17:13:26.6429039Z"
226+
},
227+
"properties": {
228+
"infrastructure": "azure",
229+
"onPremiseProperty": {
230+
"id": "4eb0a7a5-5ed6-4463-af71-12590b2fad5d",
231+
"publicSigningKey": "MIIDWzCCAkOgAwIBAgIIA8OmTJKpD8AwDQYJKoZIhvcNAQELBQAwKDEmMCQGA1UEAxMdQ2x1c3RlciBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkwHhcNMjMwMTAzMjEzNzUxWhcNMjgwMTAyMjEzNzUxWjAaMRgwFgYDVQQDEw9iaWxsaW5nLXNpZ25pbmcwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC3rAuXaXIeaipFiqGW5rtkdq/1+S58CRMEkANHvwFnimXEWIt8VnbG9foIm20r0RK+6XeRpn5r92jrOl/3R4Q9AAiF3Tgzy3NF9Dg9OsKo1bnrfWHMxmyX2w8TxyZSvWKEUVpVhjhqyhy/cqSJA5ASjEtthMx4Q1HTVcEDSTfnPHPz9EhfZqZ6ES3Yqun2D9MIatkSUpjHJbqYwRTzzrsPG84hJX7EGAWntvEzzCjmTUsouShEwUhi8c05CLBwzF5bxDNLhTdy+tj2ZyUzL7R+BmifwPR9jvOziYPlrbgIIs77sPbNlZjZvMeeBaJHktWZ0s8/UpUpV1W69m7hT2gbAgMBAAGjgZYwgZMwIAYDVR0lAQH/BBYwFAYIKwYBBQUHAwIGCCsGAQUFBwMBMA4GA1UdDwEB/wQEAwIFoDBfBgNVHREEWDBWgg5jb250cm9sbGVyLXN2Y4IoY29udHJvbGxlci1zdmMuY29udG9zby5zdmMuY2x1c3Rlci5sb2NhbIIaY29udHJvbGxlci1zdmMuY29udG9zby5zdmMwDQYJKoZIhvcNAQELBQADggEBADcZNIZcDDUC79ElbRrXdbHo9bUUv/NJfY7Dx226jc8j0AdDq8MbHAnt+JiMH6+GDb88avleA448yZ9ujBP9zC8v8IyaWu4vQpPT7MagzlsAhb6VEWU0FQfM6R14WwbATWSOIwDlMn4I33mZULyJdZhk4TqzqTQ8F0I3TavHh8TWBbjnwg1IhR/8TQ9HfgceoI80SBE3BDI5at/CzYgoWcWS2pzfd3QYwD8DIPVLCdcx1LNSDjdlQCQTKal0yKMauGIzMuYpCF1M6Z0LunPU/Ns96T9mqLXJHu+wmAoJ2CwdXa4FruwTSgrQlY3pokjTMwGaP3uzpnCSI7ykvi5kp4Q=",
232+
"signingCertificateThumbprint": "8FB48D0DD44DCFB25ECC13B9CB5F493F5438D38C"
233+
},
234+
"k8sRaw": {
235+
"kind": "DataController",
236+
"spec": {
237+
"credentials": {
238+
"dockerRegistry": "arc-private-registry",
239+
"domainServiceAccount": "domain-service-account-secret",
240+
"serviceAccount": "sa-arc-controller"
241+
},
242+
"security": {
243+
"allowDumps": true,
244+
"allowNodeMetricsCollection": true,
245+
"allowPodMetricsCollection": true
246+
},
247+
"services": [
248+
{
249+
"name": "controller",
250+
"port": 30080,
251+
"serviceType": "LoadBalancer"
252+
}
253+
],
254+
"settings": {
255+
"ElasticSearch": {
256+
"vm.max_map_count": "-1"
257+
},
258+
"azure": {
259+
"autoUploadMetrics": "true",
260+
"autoUploadLogs": "false",
261+
"subscription": "7894901a-dfga-rf4d-85r4-cc1234459df2",
262+
"resourceGroup": "contoso-rg",
263+
"location": "eastus",
264+
"connectionMode": "direct"
265+
},
266+
"controller": {
267+
"logs.rotation.days": "7",
268+
"logs.rotation.size": "5000",
269+
"displayName": "contosodc"
270+
}
271+
},
272+
"storage": {
273+
"data": {
274+
"accessMode": "ReadWriteOnce",
275+
"className": "managed-premium",
276+
"size": "15Gi"
277+
},
278+
"logs": {
279+
"accessMode": "ReadWriteOnce",
280+
"className": "managed-premium",
281+
"size": "10Gi"
282+
}
283+
},
284+
"infrastructure": "azure",
285+
"docker": {
286+
"registry": "mcr.microsoft.com",
287+
"imageTag": "v1.14.0_2022-12-13",
288+
"repository": "arcdata",
289+
"imagePullPolicy": "Always"
290+
}
291+
},
292+
"metadata": {
293+
"namespace": "contoso",
294+
"name": "contosodc",
295+
"annotations": {
296+
"management.azure.com/apiVersion": "2022-03-01-preview",
297+
"management.azure.com/cloudEnvironment": "AzureCloud",
298+
"management.azure.com/correlationId": "aa531c88-6dfb-46c3-af5b-d93f7eaaf0f6",
299+
"management.azure.com/customLocation": "/subscriptions/7894901a-dfga-rf4d-85r4-cc1234459df2/resourceGroups/contoso-rg/providers/Microsoft.ExtendedLocation/customLocations/contoso",
300+
"management.azure.com/location": "eastus",
301+
"management.azure.com/operationId": "265b98a7-0fc2-4dce-9cef-26f9b6dd000c*705EDFCA81D01028EFA1C3E9CB3CEC2BF472F25894ACB2FFDF955711236F486D",
302+
"management.azure.com/resourceId": "/subscriptions/7894901a-dfga-rf4d-85r4-cc1234459df2/resourceGroups/contoso-rg/providers/Microsoft.AzureArcData/dataControllers/contosodc",
303+
"management.azure.com/systemData": "{\"createdBy\":\"9c1a17be-338f-4b3c-90e9-55eb526c5aef\",\"createdByType\":\"User\",\"createdAt\":\"2023-01-03T21:35:36.8412132Z\",\"resourceUID\":\"74087467-4f98-4a23-bacf-a1e40404457f\"}",
304+
"management.azure.com/tenantId": "123488bf-8asd-41wf-91ab-211kl345db47",
305+
"traceparent": "00-197d885376f938d6138babf8ed4d809c-1a584b84b3c8f5df-01"
306+
},
307+
"creationTimestamp": "2023-01-03T21:35:42Z",
308+
"generation": 2,
309+
"resourceVersion": "15446366",
310+
"uid": "4eb0a7a5-5ed6-4463-af71-12590b2fad5d"
311+
},
312+
"apiVersion": "arcdata.microsoft.com/v5",
313+
"status": {
314+
"observedGeneration": 2,
315+
"state": "Ready",
316+
"azure": {
317+
"uploadStatus": {
318+
"logs": {
319+
"lastUploadTime": "0001-01-01T00:00:00Z",
320+
"message": "Automatic upload of logs is disabled. Execution time: 02/15/2023 17:07:57"
321+
},
322+
"metrics": {
323+
"lastUploadTime": "2023-02-15T17:00:57.047934Z",
324+
"message": "Success"
325+
},
326+
"usage": {
327+
"lastUploadTime": "2023-02-15T17:07:53.843439Z",
328+
"message": "Success. Records uploaded: 1."
329+
}
330+
}
331+
},
332+
"lastUpdateTime": "2023-02-15T17:07:57.587925Z",
333+
"runningVersion": "v1.14.0_2022-12-13",
334+
"arcDataServicesK8sExtensionLatestVersion": "v1.16.0",
335+
"registryVersions": {
336+
"available": [
337+
"v1.16.0_2023-02-14",
338+
"v1.15.0_2023-01-10"
339+
],
340+
"behind": 2,
341+
"current": "v1.14.0_2022-12-13",
342+
"latest": "v1.16.0_2023-02-14",
343+
"next": "v1.15.0_2023-01-10",
344+
"previous": "v1.13.0_2022-11-08"
345+
}
346+
}
347+
},
348+
"provisioningState": "Succeeded"
349+
}
350+
}
351+
```
203352

204353

205354
### PostgreSQL server - Azure Arc
@@ -222,7 +371,7 @@ The following JSON document is an example of the SQL Server database - Azure Arc
222371
- Username and password for basic authentication
223372
- `public: BasicLoginInformation BasicLoginInformation`
224373
- The raw Kubernetes information (`kubectl get postgres12`)
225-
- `object: K8sRaw` [Details](https://github.com/microsoft/azure_arc/tree/main/arc_data_services/crds)
374+
- `object: K8sRaw` [Details](https://github.com/microsoft/azure_arc/tree/main/arc_data_services/crds)
226375
- Last uploaded date from on premises cluster.
227376
- `System.DateTime: LastUploadedDate`
228377
- Group provisioning state
@@ -260,7 +409,194 @@ The following JSON document is an example of the SQL managed instance - Azure Ar
260409
- Last uploaded date from on-premises cluster.
261410
- `public: System.DateTime LastUploadedDate`
262411
- SQL managed instance provisioning state
263-
- `public string: ProvisioningState`
412+
- `public string: ProvisioningState`
413+
414+
The following JSON document is an example of the SQL Managed Instance - Azure Arc resource.
415+
416+
417+
418+
```json
419+
420+
{
421+
"id": "/subscriptions/7894901a-dfga-rf4d-85r4-cc1234459df2/resourceGroups/contoso-rg/providers/Microsoft.AzureArcData/sqlManagedInstances/sqlmi1",
422+
"name": "sqlmi1",
423+
"type": "microsoft.azurearcdata/sqlmanagedinstances",
424+
"sku": {
425+
"name": "vCore",
426+
"tier": "BusinessCritical"
427+
},
428+
"location": "eastus",
429+
"extendedLocation": {
430+
"name": "/subscriptions/7894901a-dfga-rf4d-85r4-cc1234459df2/resourcegroups/contoso-rg/providers/microsoft.extendedlocation/customlocations/contoso",
431+
"type": "CustomLocation"
432+
},
433+
"tags": {},
434+
"systemData": {
435+
"createdBy": "[email protected]",
436+
"createdByType": "User",
437+
"createdAt": "2023-01-04T01:33:57.5232885Z",
438+
"lastModifiedBy": "319f651f-7ddb-4fc6-9857-7aef9250bd05",
439+
"lastModifiedByType": "Application",
440+
"lastModifiedAt": "2023-02-15T01:39:11.6582399Z"
441+
},
442+
"properties": {
443+
"dataControllerId": "/subscriptions/7894901a-dfga-rf4d-85r4-cc1234459df2/resourceGroups/contoso-rg/providers/Microsoft.AzureArcData/dataControllers/contosodc",
444+
"admin": "sqladmin",
445+
"k8sRaw": {
446+
"spec": {
447+
"scheduling": {
448+
"default": {
449+
"resources": {
450+
"requests": {
451+
"cpu": "2",
452+
"memory": "4Gi"
453+
},
454+
"limits": {
455+
"cpu": "2",
456+
"memory": "4Gi"
457+
}
458+
}
459+
}
460+
},
461+
"replicas": 2,
462+
"dev": true,
463+
"services": {
464+
"primary": {
465+
"type": "LoadBalancer"
466+
},
467+
"readableSecondaries": {}
468+
},
469+
"readableSecondaries": 1,
470+
"syncSecondaryToCommit": 0,
471+
"storage": {
472+
"data": {
473+
"volumes": [
474+
{
475+
"size": "5Gi"
476+
}
477+
]
478+
},
479+
"logs": {
480+
"volumes": [
481+
{
482+
"size": "5Gi"
483+
}
484+
]
485+
},
486+
"datalogs": {
487+
"volumes": [
488+
{
489+
"size": "5Gi"
490+
}
491+
]
492+
},
493+
"backups": {
494+
"volumes": [
495+
{
496+
"className": "azurefile",
497+
"size": "5Gi"
498+
}
499+
]
500+
}
501+
},
502+
"security": {
503+
"adminLoginSecret": "sqlmi1-login-secret"
504+
},
505+
"tier": "BusinessCritical",
506+
"update": {},
507+
"backup": {
508+
"retentionPeriodInDays": 7
509+
},
510+
"licenseType": "LicenseIncluded",
511+
"orchestratorReplicas": 1,
512+
"parentResource": {
513+
"apiGroup": "arcdata.microsoft.com",
514+
"kind": "DataController",
515+
"name": "contosodc",
516+
"namespace": "contoso"
517+
},
518+
"settings": {
519+
"collation": "SQL_Latin1_General_CP1_CI_AS",
520+
"language": {
521+
"lcid": 1033
522+
},
523+
"network": {
524+
"forceencryption": 0,
525+
"tlsciphers": "ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-RSA-AES256-SHA384",
526+
"tlsprotocols": "1.2"
527+
},
528+
"sqlagent": {
529+
"enabled": false
530+
},
531+
"timezone": "UTC"
532+
}
533+
},
534+
"metadata": {
535+
"annotations": {
536+
"management.azure.com/apiVersion": "2022-03-01-preview",
537+
"management.azure.com/cloudEnvironment": "AzureCloud",
538+
"management.azure.com/correlationId": "3a49178d-a09f-48d3-9292-3133f6591743",
539+
"management.azure.com/customLocation": "/subscriptions/7894901a-dfga-rf4d-85r4-cc1234459df2/resourceGroups/contoso-rg/providers/microsoft.extendedlocation/customlocations/contoso",
540+
"management.azure.com/location": "eastus",
541+
"management.azure.com/operationId": "dbf2e708-78da-4762-8fd5-75ba43721b24*4C234309E6735F28E751F5734D64E8F98A910A88E54A1AD35C6469BCD0E6EA84",
542+
"management.azure.com/resourceId": "/subscriptions/7894901a-dfga-rf4d-85r4-cc1234459df2/resourceGroups/contoso-rg/providers/Microsoft.AzureArcData/sqlManagedInstances/sqlmi1",
543+
"management.azure.com/systemData": "{\"createdBy\":\"9c1a17be-338f-4b3c-90e9-55eb526c5aef\",\"createdByType\":\"User\",\"createdAt\":\"2023-01-04T01:33:57.5232885Z\",\"resourceUID\":\"40fa8b55-4b7d-4d6a-b783-043169d7fd03\"}",
544+
"management.azure.com/tenantId": "123488bf-8asd-41wf-91ab-211kl345db47",
545+
"traceparent": "00-3c07cf4caa8b4778591b02b1bf3979ef-f2ee2c890c21ea8a-01"
546+
},
547+
"creationTimestamp": "2023-01-04T01:34:03Z",
548+
"generation": 1,
549+
"labels": {
550+
"management.azure.com/resourceProvider": "Microsoft.AzureArcData"
551+
},
552+
"name": "sqlmi1",
553+
"namespace": "contoso",
554+
"resourceVersion": "15215035",
555+
"uid": "6d653cd8-f17e-437a-b0dc-48154164c1ad"
556+
},
557+
"status": {
558+
"lastUpdateTime": "2023-02-15T01:39:07.691211Z",
559+
"observedGeneration": 1,
560+
"readyReplicas": "2/2",
561+
"roles": {
562+
"sql": {
563+
"replicas": 2,
564+
"lastUpdateTime": "2023-02-14T11:37:14.875705Z",
565+
"readyReplicas": 2
566+
}
567+
},
568+
"state": "Ready",
569+
"endpoints": {
570+
"logSearchDashboard": "https://230.41.13.18:5601/app/kibana#/discover?_a=(query:(language:kuery,query:'custom_resource_name:sqlmi1'))",
571+
"metricsDashboard": "https://230.41.13.18:3000/d/40q72HnGk/sql-managed-instance-metrics?var-hostname=sqlmi1-0",
572+
"mirroring": "230.41.13.18:5022",
573+
"primary": "230.41.13.18,1433",
574+
"secondary": "230.41.13.18,1433"
575+
},
576+
"highAvailability": {
577+
"lastUpdateTime": "2023-02-14T11:47:42.208708Z",
578+
"mirroringCertificate": "-----BEGIN CERTIFICATE-----\nMIIDQzCCAiugAwIBAgIISqqmfCPaolkwDQYJKoZIhvcNAQELBQAwKDEmMCQGA1UEAxMdQ2x1c3Rl\r\nciBDZXJ0aWZpDEzNDA2WhcNMjgwMTAzMDEzNDA2WjAO\r\nMQwwCgYDVQQDEwNkYm0wggEiMA0GCSqgEKAoIBAQDEXj2nm2cGkyfu\r\npXWQ4s6G//AI1rbH4JStZOAHwJNYmBuESSHz0i6znjnQQloFe+g2KM+1m4TN1T39Lz+/ufEYQQX9\r\nx9WuGP2IALgH1LXc/0DGuOB16QXqN7ZWULQ4ovW4Aaz5NxTSDXWYPK+zpb1c8adsQyamLHwmSPs4\r\nMpsgfOR9EUCqdnuKjSHbWCtkJTYogpAFyZb5HOgY1TMICrTkXG6VYoCPS/EDNmtPOyVuykdjjsxx\r\nIC5KkVgHWTaYIDjim7L44FPh4HUIVM/OFScRijCZTJogN/Fe94+kGDWfgWIG36Jlz127BbWV3HNJ\r\nkH2oLchIABvgTXsdKnjK3i2TAgMBAAGjgYowgYcwIAYDVR0lAQH/BBYwFAYIKwYBBQUHAwIGCCsG\r\nAQUFBwMBMA4GA1UdDwEB/wQEAwIFoDBTBgNVHREETDBKggpzcWxtaTEtc3ZjgiRzcWxtaTEtc3Zj\r\nLmNvbnRvc28uc3ZjLmNsdXN0ZXIubG9jYWyCFnNxbG1pMS1zdmMuY29udG9zby5zdmMwDQYJKoZI\r\nhvcNAQELBQADggEBAA+Wj6WK9NgX4szxT7zQxPVIn+0iviO/2dFxHmjmvj+lrAffsgNdfeX5095f\r\natxIO+no6VW2eoHze2f6AECh4/KefyAzd+GL9MIksJcMLqSqAemXju3pUfGBS1SAW8Rh361D8tmA\r\nEFpPMwZG3uMidYMso0GqO0tpejz2+5Q4NpweHBGoq6jk+9ApTLD+s5qetZHrxGD6tS1Z/Lvt24lE\r\nKtSKEDw5O2qnqbsOe6xxtPAuIfTmpwIzIv2WiGC3aGuXSr0bNyPHzh5RL1MCIpwLMrnruFwVzB25\r\nA0xRalcXVZRZ1H0zbznGsecyBRJiA+7uxNB7/V6i+SjB/qxj2xKh4s8=\n-----END CERTIFICATE-----\n",
579+
"healthState": "Error",
580+
"replicas": []
581+
},
582+
"logSearchDashboard": "https://230.41.13.18:5601/app/kibana#/discover?_a=(query:(language:kuery,query:'custom_resource_name:sqlmi1'))",
583+
"metricsDashboard": "https://230.41.13.18:3000/d/40q72HnGk/sql-managed-instance-metrics?var-hostname=sqlmi1-0",
584+
"primaryEndpoint": "230.41.13.18,1433",
585+
"runningVersion": "v1.14.0_2022-12-13",
586+
"registryVersions": {
587+
"available": [],
588+
"behind": 0,
589+
"current": "v1.14.0_2022-12-13",
590+
"latest": "v1.14.0_2022-12-13",
591+
"previous": "v1.13.0_2022-11-08"
592+
}
593+
}
594+
},
595+
"provisioningState": "Succeeded",
596+
"licenseType": "LicenseIncluded"
597+
}
598+
}
599+
```
264600

265601
## Examples
266602

@@ -376,3 +712,4 @@ In support situations, you may be asked to provide database instance logs, Kuber
376712
## Next steps
377713
[Upload usage data to Azure Monitor](upload-usage-data.md)
378714

715+

0 commit comments

Comments
 (0)