|
| 1 | +{ |
| 2 | + "swagger": "2.0", |
| 3 | + "info": { |
| 4 | + "title": "Security Insights", |
| 5 | + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", |
| 6 | + "version": "2022-10-01-preview" |
| 7 | + }, |
| 8 | + "host": "management.azure.com", |
| 9 | + "schemes": [ |
| 10 | + "https" |
| 11 | + ], |
| 12 | + "consumes": [ |
| 13 | + "application/json" |
| 14 | + ], |
| 15 | + "produces": [ |
| 16 | + "application/json" |
| 17 | + ], |
| 18 | + "security": [ |
| 19 | + { |
| 20 | + "azure_auth": [ |
| 21 | + "user_impersonation" |
| 22 | + ] |
| 23 | + } |
| 24 | + ], |
| 25 | + "securityDefinitions": { |
| 26 | + "azure_auth": { |
| 27 | + "type": "oauth2", |
| 28 | + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", |
| 29 | + "flow": "implicit", |
| 30 | + "description": "Azure Active Directory OAuth2 Flow", |
| 31 | + "scopes": { |
| 32 | + "user_impersonation": "impersonate your user account" |
| 33 | + } |
| 34 | + } |
| 35 | + }, |
| 36 | + "paths": { |
| 37 | + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecurityInsights/enrichment/ip/geodata/": { |
| 38 | + "get": { |
| 39 | + "x-ms-examples": { |
| 40 | + "Get geodata for a single IP address": { |
| 41 | + "$ref": "./examples/enrichment/GetGeodataByIp.json" |
| 42 | + } |
| 43 | + }, |
| 44 | + "tags": [ |
| 45 | + "Enrichment" |
| 46 | + ], |
| 47 | + "description": "Get geodata for a single IP address", |
| 48 | + "operationId": "IPGeodata_Get", |
| 49 | + "parameters": [ |
| 50 | + { |
| 51 | + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" |
| 52 | + }, |
| 53 | + { |
| 54 | + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" |
| 55 | + }, |
| 56 | + { |
| 57 | + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" |
| 58 | + }, |
| 59 | + { |
| 60 | + "$ref": "#/parameters/EnrichmentIpAddress" |
| 61 | + } |
| 62 | + ], |
| 63 | + "responses": { |
| 64 | + "200": { |
| 65 | + "description": "OK", |
| 66 | + "schema": { |
| 67 | + "$ref": "#/definitions/EnrichmentIpGeodata" |
| 68 | + } |
| 69 | + }, |
| 70 | + "default": { |
| 71 | + "description": "Error response describing why the operation failed to enrich this ip.", |
| 72 | + "schema": { |
| 73 | + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" |
| 74 | + } |
| 75 | + } |
| 76 | + } |
| 77 | + } |
| 78 | + }, |
| 79 | + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecurityInsights/enrichment/domain/whois/": { |
| 80 | + "get": { |
| 81 | + "x-ms-examples": { |
| 82 | + "Get whois information for a single domain name": { |
| 83 | + "$ref": "./examples/enrichment/GetWhoisByDomainName.json" |
| 84 | + } |
| 85 | + }, |
| 86 | + "tags": [ |
| 87 | + "Enrichment" |
| 88 | + ], |
| 89 | + "description": "Get whois information for a single domain name", |
| 90 | + "operationId": "DomainWhois_Get", |
| 91 | + "parameters": [ |
| 92 | + { |
| 93 | + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" |
| 94 | + }, |
| 95 | + { |
| 96 | + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" |
| 97 | + }, |
| 98 | + { |
| 99 | + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" |
| 100 | + }, |
| 101 | + { |
| 102 | + "$ref": "#/parameters/EnrichmentDomain" |
| 103 | + } |
| 104 | + ], |
| 105 | + "responses": { |
| 106 | + "200": { |
| 107 | + "description": "OK", |
| 108 | + "schema": { |
| 109 | + "$ref": "#/definitions/EnrichmentDomainWhois" |
| 110 | + } |
| 111 | + }, |
| 112 | + "default": { |
| 113 | + "description": "Error response describing why the operation failed to enrich this domain.", |
| 114 | + "schema": { |
| 115 | + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" |
| 116 | + } |
| 117 | + } |
| 118 | + } |
| 119 | + } |
| 120 | + } |
| 121 | + }, |
| 122 | + "parameters": { |
| 123 | + "EnrichmentIpAddress": { |
| 124 | + "description": "IP address (v4 or v6) to be enriched", |
| 125 | + "in": "query", |
| 126 | + "name": "ipAddress", |
| 127 | + "required": true, |
| 128 | + "type": "string", |
| 129 | + "x-ms-parameter-location": "method" |
| 130 | + }, |
| 131 | + "EnrichmentDomain": { |
| 132 | + "description": "Domain name to be enriched", |
| 133 | + "in": "query", |
| 134 | + "name": "domain", |
| 135 | + "required": true, |
| 136 | + "type": "string", |
| 137 | + "x-ms-parameter-location": "method" |
| 138 | + } |
| 139 | + }, |
| 140 | + "definitions": { |
| 141 | + "EnrichmentDomainWhois": { |
| 142 | + "description": "Whois information for a given domain and associated metadata", |
| 143 | + "properties": { |
| 144 | + "domain": { |
| 145 | + "description": "The domain for this whois record", |
| 146 | + "type": "string" |
| 147 | + }, |
| 148 | + "server": { |
| 149 | + "description": "The hostname of this registrar's whois server", |
| 150 | + "type": "string" |
| 151 | + }, |
| 152 | + "created": { |
| 153 | + "description": "The timestamp at which this record was created", |
| 154 | + "format": "date-time", |
| 155 | + "type": "string" |
| 156 | + }, |
| 157 | + "updated": { |
| 158 | + "description": "The timestamp at which this record was last updated", |
| 159 | + "format": "date-time", |
| 160 | + "type": "string" |
| 161 | + }, |
| 162 | + "expires": { |
| 163 | + "description": "The timestamp at which this record will expire", |
| 164 | + "format": "date-time", |
| 165 | + "type": "string" |
| 166 | + }, |
| 167 | + "parsedWhois": { |
| 168 | + "description": "The whois record for a given domain", |
| 169 | + "$ref": "#/definitions/EnrichmentDomainWhoisDetails" |
| 170 | + } |
| 171 | + }, |
| 172 | + "type": "object" |
| 173 | + }, |
| 174 | + "EnrichmentDomainWhoisDetails": { |
| 175 | + "description": "The whois record for a given domain", |
| 176 | + "properties": { |
| 177 | + "registrar": { |
| 178 | + "description": "The registrar associated with this domain", |
| 179 | + "$ref": "#/definitions/EnrichmentDomainWhoisRegistrarDetails" |
| 180 | + }, |
| 181 | + "contacts": { |
| 182 | + "description": "The set of contacts associated with this domain", |
| 183 | + "$ref": "#/definitions/EnrichmentDomainWhoisContacts" |
| 184 | + }, |
| 185 | + "nameServers": { |
| 186 | + "description": "A list of name servers associated with this domain", |
| 187 | + "type": "array", |
| 188 | + "items": { |
| 189 | + "type": "string" |
| 190 | + } |
| 191 | + }, |
| 192 | + "statuses": { |
| 193 | + "description": "The set of status flags for this whois record", |
| 194 | + "type": "array", |
| 195 | + "items": { |
| 196 | + "type": "string" |
| 197 | + } |
| 198 | + } |
| 199 | + }, |
| 200 | + "type": "object" |
| 201 | + }, |
| 202 | + "EnrichmentDomainWhoisRegistrarDetails": { |
| 203 | + "description": "The registrar associated with this domain", |
| 204 | + "properties": { |
| 205 | + "name": { |
| 206 | + "description": "The name of this registrar", |
| 207 | + "type": "string" |
| 208 | + }, |
| 209 | + "abuseContactEmail": { |
| 210 | + "description": "This registrar's abuse contact email", |
| 211 | + "type": "string" |
| 212 | + }, |
| 213 | + "abuseContactPhone": { |
| 214 | + "description": "This registrar's abuse contact phone number", |
| 215 | + "type": "string" |
| 216 | + }, |
| 217 | + "ianaId": { |
| 218 | + "description": "This registrar's Internet Assigned Numbers Authority id", |
| 219 | + "type": "string" |
| 220 | + }, |
| 221 | + "url": { |
| 222 | + "description": "This registrar's URL", |
| 223 | + "type": "string" |
| 224 | + }, |
| 225 | + "whoisServer": { |
| 226 | + "description": "The hostname of this registrar's whois server", |
| 227 | + "type": "string" |
| 228 | + } |
| 229 | + }, |
| 230 | + "type": "object" |
| 231 | + }, |
| 232 | + "EnrichmentDomainWhoisContacts": { |
| 233 | + "description": "The set of contacts associated with this domain", |
| 234 | + "properties": { |
| 235 | + "admin": { |
| 236 | + "description": "The admin contact for this whois record", |
| 237 | + "$ref": "#/definitions/EnrichmentDomainWhoisContact" |
| 238 | + }, |
| 239 | + "billing": { |
| 240 | + "description": "The billing contact for this whois record", |
| 241 | + "$ref": "#/definitions/EnrichmentDomainWhoisContact" |
| 242 | + }, |
| 243 | + "registrant": { |
| 244 | + "description": "The registrant contact for this whois record", |
| 245 | + "$ref": "#/definitions/EnrichmentDomainWhoisContact" |
| 246 | + }, |
| 247 | + "tech": { |
| 248 | + "description": "The technical contact for this whois record", |
| 249 | + "$ref": "#/definitions/EnrichmentDomainWhoisContact" |
| 250 | + } |
| 251 | + }, |
| 252 | + "type": "object" |
| 253 | + }, |
| 254 | + "EnrichmentDomainWhoisContact": { |
| 255 | + "description": "An individual contact associated with this domain", |
| 256 | + "properties": { |
| 257 | + "name": { |
| 258 | + "description": "The name of this contact", |
| 259 | + "type": "string" |
| 260 | + }, |
| 261 | + "org": { |
| 262 | + "description": "The organization for this contact", |
| 263 | + "type": "string" |
| 264 | + }, |
| 265 | + "street": { |
| 266 | + "description": "A list describing the street address for this contact", |
| 267 | + "type": "array", |
| 268 | + "items": { |
| 269 | + "type": "string" |
| 270 | + } |
| 271 | + }, |
| 272 | + "city": { |
| 273 | + "description": "The city for this contact", |
| 274 | + "type": "string" |
| 275 | + }, |
| 276 | + "state": { |
| 277 | + "description": "The state for this contact", |
| 278 | + "type": "string" |
| 279 | + }, |
| 280 | + "postal": { |
| 281 | + "description": "The postal code for this contact", |
| 282 | + "type": "string" |
| 283 | + }, |
| 284 | + "country": { |
| 285 | + "description": "The country for this contact", |
| 286 | + "type": "string" |
| 287 | + }, |
| 288 | + "phone": { |
| 289 | + "description": "The phone number for this contact", |
| 290 | + "type": "string" |
| 291 | + }, |
| 292 | + "fax": { |
| 293 | + "description": "The fax number for this contact", |
| 294 | + "type": "string" |
| 295 | + }, |
| 296 | + "email": { |
| 297 | + "description": "The email address for this contact", |
| 298 | + "type": "string" |
| 299 | + } |
| 300 | + }, |
| 301 | + "type": "object" |
| 302 | + }, |
| 303 | + "EnrichmentIpGeodata": { |
| 304 | + "description": "Geodata information for a given IP address", |
| 305 | + "properties": { |
| 306 | + "asn": { |
| 307 | + "description": "The autonomous system number associated with this IP address", |
| 308 | + "type": "string" |
| 309 | + }, |
| 310 | + "carrier": { |
| 311 | + "description": "The name of the carrier for this IP address", |
| 312 | + "type": "string" |
| 313 | + }, |
| 314 | + "city": { |
| 315 | + "description": "The city this IP address is located in", |
| 316 | + "type": "string" |
| 317 | + }, |
| 318 | + "cityCf": { |
| 319 | + "description": "A numeric rating of confidence that the value in the 'city' field is correct, on a scale of 0-100", |
| 320 | + "type": "integer", |
| 321 | + "format": "int32" |
| 322 | + }, |
| 323 | + "continent": { |
| 324 | + "description": "The continent this IP address is located on", |
| 325 | + "type": "string" |
| 326 | + }, |
| 327 | + "country": { |
| 328 | + "description": "The county this IP address is located in", |
| 329 | + "type": "string" |
| 330 | + }, |
| 331 | + "countryCf": { |
| 332 | + "description": "A numeric rating of confidence that the value in the 'country' field is correct on a scale of 0-100", |
| 333 | + "type": "integer", |
| 334 | + "format": "int32" |
| 335 | + }, |
| 336 | + "ipAddr": { |
| 337 | + "description": "The dotted-decimal or colon-separated string representation of the IP address", |
| 338 | + "type": "string" |
| 339 | + }, |
| 340 | + "ipRoutingType": { |
| 341 | + "description": "A description of the connection type of this IP address", |
| 342 | + "type": "string" |
| 343 | + }, |
| 344 | + "latitude": { |
| 345 | + "description": "The latitude of this IP address", |
| 346 | + "type": "string" |
| 347 | + }, |
| 348 | + "longitude": { |
| 349 | + "description": "The longitude of this IP address", |
| 350 | + "type": "string" |
| 351 | + }, |
| 352 | + "organization": { |
| 353 | + "description": "The name of the organization for this IP address", |
| 354 | + "type": "string" |
| 355 | + }, |
| 356 | + "organizationType": { |
| 357 | + "description": "The type of the organization for this IP address", |
| 358 | + "type": "string" |
| 359 | + }, |
| 360 | + "region": { |
| 361 | + "description": "The geographic region this IP address is located in", |
| 362 | + "type": "string" |
| 363 | + }, |
| 364 | + "state": { |
| 365 | + "description": "The state this IP address is located in", |
| 366 | + "type": "string" |
| 367 | + }, |
| 368 | + "stateCf": { |
| 369 | + "description": "A numeric rating of confidence that the value in the 'state' field is correct on a scale of 0-100", |
| 370 | + "type": "integer", |
| 371 | + "format": "int32" |
| 372 | + }, |
| 373 | + "stateCode": { |
| 374 | + "description": "The abbreviated name for the state this IP address is located in", |
| 375 | + "type": "string" |
| 376 | + } |
| 377 | + }, |
| 378 | + "type": "object" |
| 379 | + } |
| 380 | + } |
| 381 | +} |
0 commit comments