|
| 1 | +{ |
| 2 | + "swagger": "2.0", |
| 3 | + "info": { |
| 4 | + "version": "2025-03-01-preview", |
| 5 | + "title": "AzureArcDataManagementClient", |
| 6 | + "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." |
| 7 | + }, |
| 8 | + "paths": {}, |
| 9 | + "definitions": { |
| 10 | + "ActiveDirectoryConnectorListResult": { |
| 11 | + "description": "A list of active directory connectors", |
| 12 | + "type": "object", |
| 13 | + "properties": { |
| 14 | + "value": { |
| 15 | + "description": "Array of results.", |
| 16 | + "type": "array", |
| 17 | + "items": { |
| 18 | + "$ref": "#/definitions/ActiveDirectoryConnectorResource" |
| 19 | + }, |
| 20 | + "readOnly": true |
| 21 | + }, |
| 22 | + "nextLink": { |
| 23 | + "description": "Link to retrieve next page of results.", |
| 24 | + "type": "string", |
| 25 | + "readOnly": true |
| 26 | + } |
| 27 | + } |
| 28 | + }, |
| 29 | + "ActiveDirectoryConnectorResource": { |
| 30 | + "type": "object", |
| 31 | + "description": "Active directory connector resource", |
| 32 | + "allOf": [ |
| 33 | + { |
| 34 | + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" |
| 35 | + } |
| 36 | + ], |
| 37 | + "properties": { |
| 38 | + "properties": { |
| 39 | + "$ref": "#/definitions/ActiveDirectoryConnectorProperties", |
| 40 | + "description": "null", |
| 41 | + "x-ms-client-flatten": false |
| 42 | + } |
| 43 | + }, |
| 44 | + "required": [ |
| 45 | + "properties" |
| 46 | + ] |
| 47 | + }, |
| 48 | + "ActiveDirectoryConnectorProperties": { |
| 49 | + "type": "object", |
| 50 | + "description": "The properties of an Active Directory connector resource", |
| 51 | + "properties": { |
| 52 | + "domainServiceAccountLoginInformation": { |
| 53 | + "$ref": "./common.json#/definitions/BasicLoginInformation", |
| 54 | + "description": "Username and password for domain service account authentication." |
| 55 | + }, |
| 56 | + "provisioningState": { |
| 57 | + "type": "string", |
| 58 | + "description": "The provisioning state of the Active Directory connector resource.", |
| 59 | + "readOnly": true |
| 60 | + }, |
| 61 | + "spec": { |
| 62 | + "$ref": "#/definitions/ActiveDirectoryConnectorSpec", |
| 63 | + "description": "null", |
| 64 | + "x-ms-client-flatten": false |
| 65 | + }, |
| 66 | + "status": { |
| 67 | + "$ref": "#/definitions/ActiveDirectoryConnectorStatus", |
| 68 | + "description": "null", |
| 69 | + "x-ms-client-flatten": false |
| 70 | + } |
| 71 | + }, |
| 72 | + "required": [ |
| 73 | + "spec" |
| 74 | + ] |
| 75 | + }, |
| 76 | + "ActiveDirectoryConnectorSpec": { |
| 77 | + "description": "The specifications of the AD Kubernetes resource.", |
| 78 | + "type": "object", |
| 79 | + "properties": { |
| 80 | + "activeDirectory": { |
| 81 | + "$ref": "#/definitions/ActiveDirectoryConnectorDomainDetails", |
| 82 | + "description": "null", |
| 83 | + "x-ms-client-flatten": false |
| 84 | + }, |
| 85 | + "dns": { |
| 86 | + "$ref": "#/definitions/ActiveDirectoryConnectorDNSDetails", |
| 87 | + "description": "null", |
| 88 | + "x-ms-client-flatten": false |
| 89 | + } |
| 90 | + }, |
| 91 | + "required": [ |
| 92 | + "activeDirectory", |
| 93 | + "dns" |
| 94 | + ] |
| 95 | + }, |
| 96 | + "ActiveDirectoryConnectorDomainDetails": { |
| 97 | + "type": "object", |
| 98 | + "description": "Active Directory domain details", |
| 99 | + "properties": { |
| 100 | + "realm": { |
| 101 | + "type": "string", |
| 102 | + "description": "Name (uppercase) of the Active Directory domain that this AD connector will be associated with." |
| 103 | + }, |
| 104 | + "netbiosDomainName": { |
| 105 | + "type": "string", |
| 106 | + "description": "NETBIOS name of the Active Directory domain." |
| 107 | + }, |
| 108 | + "serviceAccountProvisioning": { |
| 109 | + "type": "string", |
| 110 | + "enum": [ |
| 111 | + "automatic", |
| 112 | + "manual" |
| 113 | + ], |
| 114 | + "x-ms-enum": { |
| 115 | + "name": "accountProvisioningMode", |
| 116 | + "modelAsString": true |
| 117 | + }, |
| 118 | + "default": "manual", |
| 119 | + "description": "The service account provisioning mode for this Active Directory connector." |
| 120 | + }, |
| 121 | + "ouDistinguishedName": { |
| 122 | + "type": "string", |
| 123 | + "description": "The distinguished name of the Active Directory Organizational Unit." |
| 124 | + }, |
| 125 | + "domainControllers": { |
| 126 | + "$ref": "#/definitions/ActiveDirectoryDomainControllers", |
| 127 | + "description": "null", |
| 128 | + "x-ms-client-flatten": false |
| 129 | + } |
| 130 | + }, |
| 131 | + "required": [ |
| 132 | + "realm" |
| 133 | + ] |
| 134 | + }, |
| 135 | + "ActiveDirectoryConnectorDNSDetails": { |
| 136 | + "type": "object", |
| 137 | + "description": "DNS server details", |
| 138 | + "properties": { |
| 139 | + "domainName": { |
| 140 | + "type": "string", |
| 141 | + "description": "DNS domain name for which DNS lookups should be forwarded to the Active Directory DNS servers." |
| 142 | + }, |
| 143 | + "nameserverIPAddresses": { |
| 144 | + "type": "array", |
| 145 | + "description": "List of Active Directory DNS server IP addresses.", |
| 146 | + "items": { |
| 147 | + "type": "string", |
| 148 | + "minimum": 1 |
| 149 | + } |
| 150 | + }, |
| 151 | + "replicas": { |
| 152 | + "type": "integer", |
| 153 | + "description": "Replica count for DNS proxy service. Default value is 1.", |
| 154 | + "default": 1, |
| 155 | + "format": "int64" |
| 156 | + }, |
| 157 | + "preferK8sDnsForPtrLookups": { |
| 158 | + "type": "boolean", |
| 159 | + "description": "Flag indicating whether to prefer Kubernetes DNS server response over AD DNS server response for IP address lookups.", |
| 160 | + "default": true |
| 161 | + } |
| 162 | + }, |
| 163 | + "required": [ |
| 164 | + "nameserverIPAddresses" |
| 165 | + ] |
| 166 | + }, |
| 167 | + "ActiveDirectoryDomainControllers": { |
| 168 | + "type": "object", |
| 169 | + "description": "Details about the Active Directory domain controllers associated with this AD connector instance", |
| 170 | + "properties": { |
| 171 | + "primaryDomainController": { |
| 172 | + "$ref": "#/definitions/ActiveDirectoryDomainController", |
| 173 | + "description": "Information about the Primary Domain Controller (PDC) in the AD domain.", |
| 174 | + "x-ms-client-flatten": false |
| 175 | + }, |
| 176 | + "secondaryDomainControllers": { |
| 177 | + "$ref": "#/definitions/ActiveDirectorySecondaryDomainControllers", |
| 178 | + "description": "null", |
| 179 | + "x-ms-client-flatten": false |
| 180 | + } |
| 181 | + } |
| 182 | + }, |
| 183 | + "ActiveDirectoryDomainController": { |
| 184 | + "type": "object", |
| 185 | + "description": "Information about a domain controller in the AD domain.", |
| 186 | + "properties": { |
| 187 | + "hostname": { |
| 188 | + "type": "string", |
| 189 | + "description": "Fully-qualified domain name of a domain controller in the AD domain." |
| 190 | + } |
| 191 | + }, |
| 192 | + "required": [ |
| 193 | + "hostname" |
| 194 | + ] |
| 195 | + }, |
| 196 | + "ActiveDirectorySecondaryDomainControllers": { |
| 197 | + "type": "array", |
| 198 | + "description": "Information about the secondary domain controllers in the AD domain.", |
| 199 | + "items": { |
| 200 | + "$ref": "#/definitions/ActiveDirectoryDomainController", |
| 201 | + "description": "List of the fully-qualified domain names of the secondary domain controllers in the AD domain.", |
| 202 | + "x-ms-client-flatten": false |
| 203 | + }, |
| 204 | + "x-ms-identifiers": [ |
| 205 | + "hostname" |
| 206 | + ] |
| 207 | + }, |
| 208 | + "ActiveDirectoryConnectorStatus": { |
| 209 | + "type": "object", |
| 210 | + "description": "The status of the Kubernetes custom resource.", |
| 211 | + "properties": { |
| 212 | + "lastUpdateTime": { |
| 213 | + "type": "string", |
| 214 | + "description": "The time that the custom resource was last updated." |
| 215 | + }, |
| 216 | + "observedGeneration": { |
| 217 | + "type": "integer", |
| 218 | + "format": "int64", |
| 219 | + "description": "The version of the replicaSet associated with the AD connector custom resource." |
| 220 | + }, |
| 221 | + "state": { |
| 222 | + "type": "string", |
| 223 | + "description": "The state of the AD connector custom resource." |
| 224 | + } |
| 225 | + }, |
| 226 | + "additionalProperties": {} |
| 227 | + } |
| 228 | + }, |
| 229 | + "securityDefinitions": { |
| 230 | + "azure_auth": { |
| 231 | + "type": "oauth2", |
| 232 | + "description": "Azure Active Directory OAuth2 Flow", |
| 233 | + "flow": "implicit", |
| 234 | + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", |
| 235 | + "scopes": { |
| 236 | + "user_impersonation": "impersonate your user account" |
| 237 | + } |
| 238 | + } |
| 239 | + } |
| 240 | +} |
0 commit comments