openapi-directory/api/azure.com/sql-managedInstanceAdministrators.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":"2017-03-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/2017-03-01-preview/managedInstanceAdministrators.json","version":"2.0"}],"x-providerName":"azure.com","x-serviceName":"sql-managedInstanceAdministrators","x-tags":["Azure","Microsoft"]},"paths":{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/administrators":{"get":{"description":"Gets a list of managed instance administrators.","operationId":"ManagedInstanceAdministrators_ListByInstance","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ManagedInstanceNameParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved the list of managed instance administrators.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedInstanceAdministratorListResult"},"examples":{"List administrators of managed instance":{"$ref":"#/components/examples/List_administrators_of_managed_instance"}}}}},"default":{"description":"*** Error Responses: ***\n\n * 400 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 ManagedInstanceNotInSubscriptionResourceGroup - Specified managed instance does not exist in the specified resource group and subscription.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout."}},"tags":["ManagedInstanceAdministrators"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/administrators/{administratorName}":{"delete":{"description":"Deletes a managed instance administrator.","operationId":"ManagedInstanceAdministrators_Delete","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ManagedInstanceNameParameter"},{"description":"The administrator name.","in":"path","name":"administratorName","required":true,"x-ms-enum":{"name":"AdministratorName"},"schema":{"type":"string","enum":["ActiveDirectory"]},"examples":{"Delete administrator of managed instance":{"value":"ActiveDirectory"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully deleted the managed instance administrator."},"202":{"description":"Accepted"},"default":{"description":"*** Error Responses: ***\n\n * 400 SubscriptionNotFound - The requested subscription was not found.\n\n * 400 InvalidManagedServerAdministratorType - Invalid administrator type specified in properties.\n\n * 400 InvalidResourceRequestBody - The resource or resource properties in the request body is empty or invalid.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 InvalidLoginName - The provided login name is invalid.\n\n * 400 PrincipalNotFoundInTenant - AzureAD Lookup returned no results for this name.\n\n * 400 ManagedInstanceIsBusy - Managed Instance is busy with another request.\n\n * 400 InvalidPrincipalType - This principal type is not supported in Windows Azure SQL Database.\n\n * 400 TenantNotFoundInActiveDirectory - Tenant is not available in active directory.\n\n * 400 InvalidUsername - Supplied user name contains invalid characters.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 ManagedInstanceNotInSubscriptionResourceGroup - Specified managed instance does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 ActiveDirectoryLookupTimedOut - The operation could not be completed at this time. Please try again later.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout."}},"tags":["ManagedInstanceAdministrators"],"x-ms-long-running-operation":true},"get":{"description":"Gets a managed instance administrator.","operationId":"ManagedInstanceAdministrators_Get","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ManagedInstanceNameParameter"},{"description":"The administrator name.","in":"path","name":"administratorName","required":true,"x-ms-enum":{"name":"AdministratorName"},"schema":{"type":"string","enum":["ActiveDirectory"]},"examples":{"Get administrator of managed instance":{"value":"ActiveDirectory"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved the specified managed instance administrator.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedInstanceAdministrator"},"examples":{"Get administrator of managed instance":{"$ref":"#/components/examples/Get_administrator_of_managed_instance"}}}}},"default":{"description":"*** Error Responses: ***\n\n * 400 SubscriptionNotFound - The requested subscription was not found.\n\n * 400 InvalidManagedServerAdministratorType - Invalid administrator type specified in properties.\n\n * 400 InvalidResourceRequestBody - The resource or resource properties in the request body is empty or invalid.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 ManagedInstanceNotInSubscriptionResourceGroup - Specified managed instance does not exist in the specified resource group and subscription.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout."}},"tags":["ManagedInstanceAdministrators"]},"put":{"description":"Creates or updates a managed instance administrator.","operationId":"ManagedInstanceAdministrators_CreateOrUpdate","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ManagedInstanceNameParameter"},{"description":"The requested administrator name.","in":"path","name":"administratorName","required":true,"x-ms-enum":{"name":"AdministratorName"},"schema":{"type":"string","enum":["ActiveDirectory"]},"examples":{"Create administrator of managed instance":{"value":"ActiveDirectory"},"Update administrator of managed instance":{"value":"ActiveDirectory"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedInstanceAdministrator"}}},"description":"The requested administrator parameters.","required":true},"responses":{"200":{"description":"Successfully updated the managed instance administrator.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedInstanceAdministrator"},"examples":{"Create administrator of managed instance":{"$ref":"#/components/examples/Create_administrator_of_managed_instance"},"Update administrator of managed instance":{"$ref":"#/components/examples/Update_administrator_of_managed_instance"}}}}},"201":{"description":"Successfully created the managed instance administrator.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedInstanceAdministrator"},"examples":{"Create administrator of managed instance":{"$ref":"#/components/examples/Create_administrator_of_managed_instance"},"Update administrator of managed instance":{"$ref":"#/components/examples/Update_administrator_of_managed_instance"}}}}},"202":{"description":"Accepted"},"default":{"description":"*** Error Responses: ***\n\n * 400 SubscriptionNotFound - The requested subscription was not found.\n\n * 400 InvalidManagedServerAdministratorType - Invalid administrator type specified in properties.\n\n * 400 InvalidResourceRequestBody - The resource or resource properties in the request body is empty or invalid.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 InvalidLoginName - The provided login name is invalid.\n\n * 400 PrincipalNotFoundInTenant - AzureAD Lookup returned no results for this name.\n\n * 400 ManagedInstanceIsBusy - Managed Instance is busy with another request.\n\n * 400 InvalidPrincipalType - This principal type is not supported in Windows Azure SQL Database.\n\n * 400 TenantNotFoundInActiveDirectory - Tenant is not available in active directory.\n\n * 400 InvalidUsername - Supplied user name contains invalid characters.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 ManagedInstanceNotInSubscriptionResourceGroup - Specified managed instance does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 ActiveDirectoryLookupTimedOut - The operation could not be completed at this time. Please try again later.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout."}},"tags":["ManagedInstanceAdministrators"],"x-ms-long-running-operation":true}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"List_administrators_of_managed_instance":{"value":{"value":[{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstances/managedInstance/administrators/ActiveDirectory","name":"ActiveDirectory","properties":{"administratorType":"ActiveDirectory","login":"bob@contoso.com","sid":"44444444-3333-2222-1111-000000000000","tenantId":"55555555-4444-3333-2222-111111111111"},"type":"Microsoft.Sql/managedInstances/administrators"}]}},"Get_administrator_of_managed_instance":{"value":{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstances/managedInstance/administrators/ActiveDirectory","name":"ActiveDirectory","properties":{"administratorType":"ActiveDirectory","login":"bob@contoso.com","sid":"44444444-3333-2222-1111-000000000000","tenantId":"55555555-4444-3333-2222-111111111111"},"type":"Microsoft.Sql/managedInstances/administrators"}},"Create_administrator_of_managed_instance":{"value":{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstances/managedInstance/administrators/ActiveDirectory","name":"ActiveDirectory","properties":{"administratorType":"ActiveDirectory","login":"bob@contoso.com","sid":"44444444-3333-2222-1111-000000000000","tenantId":"55555555-4444-3333-2222-111111111111"},"type":"Microsoft.Sql/managedInstances/administrators"}},"Update_administrator_of_managed_instance":{"value":{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstances/managedInstance/administrators/ActiveDirectory","name":"ActiveDirectory","properties":{"administratorType":"ActiveDirectory","login":"bob@contoso.com","sid":"44444444-3333-2222-1111-000000000000","tenantId":"55555555-4444-3333-2222-111111111111"},"type":"Microsoft.Sql/managedInstances/administrators"}}},"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":{"List administrators of managed instance":{"value":"2017-03-01-preview"},"Delete administrator of managed instance":{"value":"2017-03-01-preview"},"Get administrator of managed instance":{"value":"2017-03-01-preview"},"Create administrator of managed instance":{"value":"2017-03-01-preview"},"Update administrator of managed instance":{"value":"2017-03-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"},"examples":{"List administrators of managed instance":{"value":"managedInstance"},"Delete administrator of managed instance":{"value":"managedInstance"},"Get administrator of managed instance":{"value":"managedInstance"},"Create administrator of managed instance":{"value":"managedInstance"},"Update administrator of managed instance":{"value":"managedInstance"}}},"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":{"List administrators of managed instance":{"value":"Default-SQL-SouthEastAsia"},"Delete administrator of managed instance":{"value":"Default-SQL-SouthEastAsia"},"Get administrator of managed instance":{"value":"Default-SQL-SouthEastAsia"},"Create administrator of managed instance":{"value":"Default-SQL-SouthEastAsia"},"Update administrator of managed instance":{"value":"Default-SQL-SouthEastAsia"}}},"ServerNameParameter":{"description":"The name of the server.","in":"path","name":"serverName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"}},"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":{"List administrators of managed instance":{"value":"00000000-1111-2222-3333-444444444444"},"Delete administrator of managed instance":{"value":"00000000-1111-2222-3333-444444444444"},"Get administrator of managed instance":{"value":"00000000-1111-2222-3333-444444444444"},"Create administrator of managed instance":{"value":"00000000-1111-2222-3333-444444444444"},"Update administrator of managed instance":{"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":{"ManagedInstanceAdministrator":{"allOf":[{"$ref":"#/components/schemas/ProxyResource"}],"description":"An Azure SQL managed instance administrator.","properties":{"properties":{"$ref":"#/components/schemas/ManagedInstanceAdministratorProperties"}},"type":"object"},"ManagedInstanceAdministratorListResult":{"description":"A list of managed instance administrators.","properties":{"nextLink":{"description":"Link to retrieve next page of results.","readOnly":true,"type":"string"},"value":{"description":"Array of results.","items":{"$ref":"#/components/schemas/ManagedInstanceAdministrator"},"readOnly":true,"type":"array"}},"type":"object"},"ManagedInstanceAdministratorProperties":{"description":"The properties of a managed instance administrator.","properties":{"administratorType":{"description":"Type of the managed instance administrator.","enum":["ActiveDirectory"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"ManagedInstanceAdministratorType"}},"login":{"description":"Login name of the managed instance administrator.","type":"string"},"sid":{"description":"SID (object ID) of the managed instance administrator.","format":"uuid","type":"string"},"tenantId":{"description":"Tenant ID of the managed instance administrator.","format":"uuid","type":"string"}},"required":["administratorType","login","sid"],"type":"object"},"ProxyResource":{"allOf":[{"$ref":"#/components/schemas/Resource"}],"description":"ARM proxy resource.","properties":{},"type":"object"},"Resource":{"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}}}}