openapi-directory/api/azure.com/sql-ServerVulnerabilityAssessments.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"description":"The Azure SQL Database management API provides a RESTful set of web APIs that interact with Azure SQL Database services to manage your databases. The API enables users to create, retrieve, update, and delete databases, servers, and other entities.","title":"SqlManagementClient","version":"2018-06-01-preview","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/ServerVulnerabilityAssessments.json","version":"2.0"}],"x-providerName":"azure.com","x-serviceName":"sql-ServerVulnerabilityAssessments","x-tags":["Azure","Microsoft"]},"paths":{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/vulnerabilityAssessments":{"get":{"description":"Lists the vulnerability assessment policies associated with a server.","operationId":"ServerVulnerabilityAssessments_ListByServer","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ServerNameParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved the server vulnerability assessment policies.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerVulnerabilityAssessmentListResult"},"examples":{"Get a server's vulnerability assessment policies":{"$ref":"#/components/examples/Get_a_server_s_vulnerability_assessment_policies"}}}}},"default":{"description":"*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature or account storage key is not valid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found"}},"tags":["ServerVulnerabilityAssessments"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/vulnerabilityAssessments/{vulnerabilityAssessmentName}":{"delete":{"description":"Removes the server's vulnerability assessment.","operationId":"ServerVulnerabilityAssessments_Delete","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"description":"The name of the server for which the vulnerability assessment is defined.","in":"path","name":"serverName","required":true,"schema":{"type":"string"},"examples":{"Remove a server's vulnerability assessment":{"value":"vulnerabilityaseessmenttest-6440"}}},{"description":"The name of the vulnerability assessment.","in":"path","name":"vulnerabilityAssessmentName","required":true,"x-ms-enum":{"modelAsString":true,"name":"VulnerabilityAssessmentName"},"schema":{"type":"string","enum":["default"]},"examples":{"Remove a server's vulnerability assessment":{"value":"default"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully removed the server vulnerability assessment."},"default":{"description":"*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature or account storage key is not valid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found"}},"tags":["ServerVulnerabilityAssessments"]},"get":{"description":"Gets the server's vulnerability assessment.","operationId":"ServerVulnerabilityAssessments_Get","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"description":"The name of the server for which the vulnerability assessment is defined.","in":"path","name":"serverName","required":true,"schema":{"type":"string"},"examples":{"Get a server's vulnerability assessment":{"value":"vulnerabilityaseessmenttest-6440"}}},{"description":"The name of the vulnerability assessment.","in":"path","name":"vulnerabilityAssessmentName","required":true,"x-ms-enum":{"modelAsString":true,"name":"VulnerabilityAssessmentName"},"schema":{"type":"string","enum":["default"]},"examples":{"Get a server's vulnerability assessment":{"value":"default"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved the server vulnerability assessment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerVulnerabilityAssessment"},"examples":{"Get a server's vulnerability assessment":{"$ref":"#/components/examples/Get_a_server_s_vulnerability_assessment"}}}}},"default":{"description":"*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature or account storage key is not valid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found"}},"tags":["ServerVulnerabilityAssessments"]},"put":{"description":"Creates or updates the server's vulnerability assessment.","operationId":"ServerVulnerabilityAssessments_CreateOrUpdate","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"description":"The name of the server for which the vulnerability assessment is defined.","in":"path","name":"serverName","required":true,"schema":{"type":"string"},"examples":{"Create a server's vulnerability assessment with all parameters":{"value":"vulnerabilityaseessmenttest-6440"},"Create a server's vulnerability assessment with minimal parameters, when storageAccountAccessKey is specified":{"value":"vulnerabilityaseessmenttest-6440"},"Create a server's vulnerability assessment with minimal parameters, when storageContainerSasKey is specified":{"value":"vulnerabilityaseessmenttest-6440"}}},{"description":"The name of the vulnerability assessment.","in":"path","name":"vulnerabilityAssessmentName","required":true,"x-ms-enum":{"modelAsString":true,"name":"VulnerabilityAssessmentName"},"schema":{"type":"string","enum":["default"]},"examples":{"Create a server's vulnerability assessment with all parameters":{"value":"default"},"Create a server's vulnerability assessment with minimal parameters, when storageAccountAccessKey is specified":{"value":"default"},"Create a server's vulnerability assessment with minimal parameters, when storageContainerSasKey is specified":{"value":"default"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerVulnerabilityAssessment"}}},"description":"The requested resource.","required":true},"responses":{"200":{"description":"Successfully set the vulnerability assessment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerVulnerabilityAssessment"},"examples":{"Create a server's vulnerability assessment with all parameters":{"$ref":"#/components/examples/Create_a_server_s_vulnerability_assessment_with_all_parameters"},"Create a server's vulnerability assessment with minimal parameters, when storageAccountAccessKey is specified":{"$ref":"#/components/examples/Create_a_server_s_vulnerability_assessment_with_minimal_parameters_when_storageAccountAccessKey_is_specified"},"Create a server's vulnerability assessment with minimal parameters, when storageContainerSasKey is specified":{"$ref":"#/components/examples/Create_a_server_s_vulnerability_assessment_with_minimal_parameters_when_storageContainerSasKey_is_specified"}}}}},"201":{"description":"Successfully created the vulnerability assessment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerVulnerabilityAssessment"},"examples":{"Create a server's vulnerability assessment with all parameters":{"$ref":"#/components/examples/Create_a_server_s_vulnerability_assessment_with_all_parameters"},"Create a server's vulnerability assessment with minimal parameters, when storageAccountAccessKey is specified":{"$ref":"#/components/examples/Create_a_server_s_vulnerability_assessment_with_minimal_parameters_when_storageAccountAccessKey_is_specified"},"Create a server's vulnerability assessment with minimal parameters, when storageContainerSasKey is specified":{"$ref":"#/components/examples/Create_a_server_s_vulnerability_assessment_with_minimal_parameters_when_storageContainerSasKey_is_specified"}}}}},"default":{"description":"*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature or account storage key is not valid.\n\n * 400 InvalidVulnerabilityAssessmentOperationRequest - The vulnerability assessment operation request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found"}},"tags":["ServerVulnerabilityAssessments"]}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"Get_a_server_s_vulnerability_assessment_policies":{"value":{"value":[{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Sql/servers/vulnerabilityaseessmenttest-6440/vulnerabilityAssessments/default","name":"default","properties":{"recurringScans":{"emailSubscriptionAdmins":true,"emails":["email1@mail.com","email2@mail.com"],"isEnabled":true},"storageContainerPath":"https://myStorage.blob.core.windows.net/vulnerability-assessment/"},"type":"Microsoft.Sql/servers/vulnerabilityAssessments"}]}},"Get_a_server_s_vulnerability_assessment":{"value":{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Sql/servers/vulnerabilityaseessmenttest-6440/vulnerabilityAssessments/default","name":"default","properties":{"recurringScans":{"emailSubscriptionAdmins":true,"emails":["email1@mail.com","email2@mail.com"],"isEnabled":true},"storageContainerPath":"https://myStorage.blob.core.windows.net/vulnerability-assessment/"},"type":"Microsoft.Sql/servers/vulnerabilityAssessments"}},"Create_a_server_s_vulnerability_assessment_with_all_parameters":{"value":{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Sql/servers/vulnerabilityaseessmenttest-6440/vulnerabilityAssessments/default","name":"default","properties":{"recurringScans":{"emailSubscriptionAdmins":true,"emails":["email1@mail.com","email2@mail.com"],"isEnabled":true},"storageContainerPath":"https://myStorage.blob.core.windows.net/vulnerability-assessment/"},"type":"Microsoft.Sql/servers/vulnerabilityAssessments"}},"Create_a_server_s_vulnerability_assessment_with_minimal_parameters_when_storageAccountAccessKey_is_specified":{"value":{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Sql/servers/vulnerabilityaseessmenttest-6440/vulnerabilityAssessments/default","name":"default","properties":{"recurringScans":{"emailSubscriptionAdmins":false,"emails":[],"isEnabled":true},"storageContainerPath":"https://myStorage.blob.core.windows.net/vulnerability-assessment/"},"type":"Microsoft.Sql/servers/vulnerabilityAssessments"}},"Create_a_server_s_vulnerability_assessment_with_minimal_parameters_when_storageContainerSasKey_is_specified":{"value":{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Sql/servers/vulnerabilityaseessmenttest-6440/vulnerabilityAssessments/default","name":"default","properties":{"recurringScans":{"emailSubscriptionAdmins":false,"emails":[],"isEnabled":true},"storageContainerPath":"https://myStorage.blob.core.windows.net/vulnerability-assessment/"},"type":"Microsoft.Sql/servers/vulnerabilityAssessments"}}},"parameters":{"ApiVersionParameter":{"description":"The API version to use for the request.","in":"query","name":"api-version","required":true,"x-ms-parameter-location":"client","schema":{"type":"string"},"examples":{"Get a server's vulnerability assessment policies":{"value":"2018-06-01-preview"},"Remove a server's vulnerability assessment":{"value":"2018-06-01-preview"},"Get a server's vulnerability assessment":{"value":"2018-06-01-preview"},"Create a server's vulnerability assessment with all parameters":{"value":"2018-06-01-preview"},"Create a server's vulnerability assessment with minimal parameters, when storageAccountAccessKey is specified":{"value":"2018-06-01-preview"},"Create a server's vulnerability assessment with minimal parameters, when storageContainerSasKey is specified":{"value":"2018-06-01-preview"}}},"BlobAuditingPolicyNameParameter":{"description":"The name of the blob auditing policy.","in":"path","name":"blobAuditingPolicyName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","enum":["default"]}},"DatabaseNameParameter":{"description":"The name of the database.","in":"path","name":"databaseName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"}},"ManagedInstanceNameParameter":{"description":"The name of the managed instance.","in":"path","name":"managedInstanceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"}},"ResourceGroupParameter":{"description":"The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Get a server's vulnerability assessment policies":{"value":"vulnerabilityaseessmenttest-4799"},"Remove a server's vulnerability assessment":{"value":"vulnerabilityaseessmenttest-4799"},"Get a server's vulnerability assessment":{"value":"vulnerabilityaseessmenttest-4799"},"Create a server's vulnerability assessment with all parameters":{"value":"vulnerabilityaseessmenttest-4799"},"Create a server's vulnerability assessment with minimal parameters, when storageAccountAccessKey is specified":{"value":"vulnerabilityaseessmenttest-4799"},"Create a server's vulnerability assessment with minimal parameters, when storageContainerSasKey is specified":{"value":"vulnerabilityaseessmenttest-4799"}}},"ServerNameParameter":{"description":"The name of the server.","in":"path","name":"serverName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Get a server's vulnerability assessment policies":{"value":"vulnerabilityaseessmenttest-6440"}}},"SqlVirtualMachineContainerNameParameter":{"description":"The name of the SqlVirtualMachineContainer.","in":"path","name":"sqlVirtualMachineContainerName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"}},"SqlVirtualMachineInstanceNameParameter":{"description":"The name of the SqlVirtualMachineInstance.","in":"path","name":"sqlVirtualMachineInstanceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"}},"SubscriptionIdParameter":{"description":"The subscription ID that identifies an Azure subscription.","in":"path","name":"subscriptionId","required":true,"x-ms-parameter-location":"client","schema":{"type":"string"},"examples":{"Get a server's vulnerability assessment policies":{"value":"00000000-1111-2222-3333-444444444444"},"Remove a server's vulnerability assessment":{"value":"00000000-1111-2222-3333-444444444444"},"Get a server's vulnerability assessment":{"value":"00000000-1111-2222-3333-444444444444"},"Create a server's vulnerability assessment with all parameters":{"value":"00000000-1111-2222-3333-444444444444"},"Create a server's vulnerability assessment with minimal parameters, when storageAccountAccessKey is specified":{"value":"00000000-1111-2222-3333-444444444444"},"Create a server's vulnerability assessment with minimal parameters, when storageContainerSasKey is specified":{"value":"00000000-1111-2222-3333-444444444444"}}},"VirtualClusterNameParameter":{"description":"The name of the virtual cluster.","in":"path","name":"virtualClusterName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"}}},"securitySchemes":{"azure_auth":{"description":"Azure Active Directory OAuth2 Flow","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize","scopes":{"user_impersonation":"impersonate your user account"}}}}},"schemas":{"ServerVulnerabilityAssessment":{"allOf":[{"allOf":[{"description":"ARM resource.","properties":{"id":{"description":"Resource ID.","readOnly":true,"type":"string"},"name":{"description":"Resource name.","readOnly":true,"type":"string"},"type":{"description":"Resource type.","readOnly":true,"type":"string"}},"type":"object","x-ms-azure-resource":true}],"description":"ARM proxy resource.","properties":{},"type":"object"}],"description":"A server vulnerability assessment.","properties":{"properties":{"$ref":"#/components/schemas/ServerVulnerabilityAssessmentProperties"}},"type":"object"},"ServerVulnerabilityAssessmentListResult":{"description":"A list of the server's vulnerability assessments.","properties":{"nextLink":{"description":"Link to retrieve next page of results.","readOnly":true,"type":"string"},"value":{"description":"Array of results.","items":{"$ref":"#/components/schemas/ServerVulnerabilityAssessment"},"readOnly":true,"type":"array"}},"type":"object"},"ServerVulnerabilityAssessmentProperties":{"description":"Properties of a server Vulnerability Assessment.","properties":{"recurringScans":{"$ref":"#/components/schemas/VulnerabilityAssessmentRecurringScansProperties"},"storageAccountAccessKey":{"description":"Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required.","type":"string","x-ms-mutability":["create","update"]},"storageContainerPath":{"description":"A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/).","type":"string","x-ms-mutability":["create","update"]},"storageContainerSasKey":{"description":"A shared access signature (SAS Key) that has read and write access to the blob container specified in 'storageContainerPath' parameter. If 'storageAccountAccessKey' isn't specified, StorageContainerSasKey is required.","type":"string","x-ms-mutability":["create","update"]}},"required":["storageContainerPath"],"type":"object"},"VulnerabilityAssessmentRecurringScansProperties":{"description":"Properties of a Vulnerability Assessment recurring scans.","properties":{"emailSubscriptionAdmins":{"default":true,"description":"Specifies that the schedule scan notification will be is sent to the subscription administrators.","type":"boolean"},"emails":{"description":"Specifies an array of e-mail addresses to which the scan notification is sent.","items":{"type":"string"},"type":"array"},"isEnabled":{"description":"Recurring scans state.","type":"boolean"}},"type":"object"}}}}