{ "swagger": "2.0", "info": { "title": "SqlManagementClient", "version": "2025-01-01", "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.", "x-typespec-generated": [ { "emitter": "@azure-tools/typespec-autorest" } ] }, "schemes": [ "https" ], "host": "management.azure.com", "produces": [ "application/json" ], "consumes": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "description": "Azure Active Directory OAuth2 Flow.", "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { "user_impersonation": "impersonate your user account" } } }, "tags": [ { "name": "ManagedInstanceAzureADOnlyAuthentications" } ], "paths": { "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/azureADOnlyAuthentications": { "get": { "operationId": "ManagedInstanceAzureADOnlyAuthentications_ListByInstance", "tags": [ "ManagedInstanceAzureADOnlyAuthentications" ], "description": "Gets a list of server Azure Active Directory only authentications.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "managedInstanceName", "in": "path", "description": "The name of the managed instance.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ManagedInstanceAzureADOnlyAuthListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Gets a list of Azure Active Directory only authentication object.": { "$ref": "./examples/ManagedInstanceAzureADOnlyAuthListByInstance.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/azureADOnlyAuthentications/{authenticationName}": { "get": { "operationId": "ManagedInstanceAzureADOnlyAuthentications_Get", "tags": [ "ManagedInstanceAzureADOnlyAuthentications" ], "description": "Gets a specific Azure Active Directory only authentication property.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "managedInstanceName", "in": "path", "description": "The name of the managed instance.", "required": true, "type": "string" }, { "name": "authenticationName", "in": "path", "description": "The name of server azure active directory only authentication.", "required": true, "type": "string", "enum": [ "Default" ], "x-ms-enum": { "name": "AuthenticationName", "modelAsString": true, "values": [ { "name": "Default", "value": "Default", "description": "Default" } ] } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ManagedInstanceAzureADOnlyAuthentication" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Gets a Azure Active Directory only authentication property.": { "$ref": "./examples/ManagedInstanceAzureADOnlyAuthGet.json" } } }, "put": { "operationId": "ManagedInstanceAzureADOnlyAuthentications_CreateOrUpdate", "tags": [ "ManagedInstanceAzureADOnlyAuthentications" ], "description": "Sets Server Active Directory only authentication property or updates an existing server Active Directory only authentication property.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "managedInstanceName", "in": "path", "description": "The name of the managed instance.", "required": true, "type": "string" }, { "name": "authenticationName", "in": "path", "description": "The name of server azure active directory only authentication.", "required": true, "type": "string", "enum": [ "Default" ], "x-ms-enum": { "name": "AuthenticationName", "modelAsString": true, "values": [ { "name": "Default", "value": "Default", "description": "Default" } ] } }, { "name": "parameters", "in": "body", "description": "The required parameters for creating or updating an Active Directory only authentication property.", "required": true, "schema": { "$ref": "#/definitions/ManagedInstanceAzureADOnlyAuthentication" } } ], "responses": { "200": { "description": "Resource 'ManagedInstanceAzureADOnlyAuthentication' update operation succeeded", "schema": { "$ref": "#/definitions/ManagedInstanceAzureADOnlyAuthentication" } }, "201": { "description": "Resource 'ManagedInstanceAzureADOnlyAuthentication' create operation succeeded", "schema": { "$ref": "#/definitions/ManagedInstanceAzureADOnlyAuthentication" }, "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Creates or updates Azure Active Directory only authentication object.": { "$ref": "./examples/ManagedInstanceAzureADOnlyAuthCreateOrUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/ManagedInstanceAzureADOnlyAuthentication" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "ManagedInstanceAzureADOnlyAuthentications_Delete", "tags": [ "ManagedInstanceAzureADOnlyAuthentications" ], "description": "Deletes an existing server Active Directory only authentication property.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "managedInstanceName", "in": "path", "description": "The name of the managed instance.", "required": true, "type": "string" }, { "name": "authenticationName", "in": "path", "description": "The name of server azure active directory only authentication.", "required": true, "type": "string", "enum": [ "Default" ], "x-ms-enum": { "name": "AuthenticationName", "modelAsString": true, "values": [ { "name": "Default", "value": "Default", "description": "Default" } ] } } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Deletes Azure Active Directory only authentication object.": { "$ref": "./examples/ManagedInstanceAzureADOnlyAuthDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } } }, "definitions": { "ManagedInstanceAzureADOnlyAuthListResult": { "type": "object", "description": "List of managed database move operations.", "properties": { "value": { "type": "array", "description": "Array of results.", "items": { "$ref": "#/definitions/ManagedInstanceAzureADOnlyAuthentication" }, "readOnly": true }, "nextLink": { "type": "string", "description": "Link to retrieve next page of results.", "readOnly": true } } }, "ManagedInstanceAzureADOnlyAuthProperties": { "type": "object", "description": "Properties of a active directory only authentication for Managed Instance.", "properties": { "azureADOnlyAuthentication": { "type": "boolean", "description": "Azure Active Directory only Authentication enabled." } }, "required": [ "azureADOnlyAuthentication" ] }, "ManagedInstanceAzureADOnlyAuthentication": { "type": "object", "description": "Azure Active Directory only authentication.", "properties": { "properties": { "$ref": "#/definitions/ManagedInstanceAzureADOnlyAuthProperties", "description": "Resource properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] } }, "parameters": {} }