openapi: 3.2.0 info: title: Applications.Datastores Resource Management Sql Databases… version: 2023-10-01-preview description: REST APIs for Applications.Datastores x-typespec-generated: - emitter: '@azure-tools/typespec-autorest' servers: - url: https://management.azure.com security: - azure_auth: - user_impersonation tags: - name: Sql Databases paths: /{rootScope}/providers/Applications.Datastores/sqlDatabases: get: operationId: SqlDatabases_ListByScope tags: - Sql Databases description: List SqlDatabaseResource resources by Scope parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: '#/components/parameters/RootScopeParameter' responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/SqlDatabaseResourceListResult' default: description: An unexpected error response. content: application/json: schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: List SqlDatabases resources by resource group: $ref: ./examples/SQLDatabases_List.json List SqlDatabases resources by rootScope: $ref: ./examples/SQLDatabases_ListByRootScope.json x-ms-pageable: nextLinkName: nextLink summary: Sql databases list by scope x-summary-source: derived /{rootScope}/providers/Applications.Datastores/sqlDatabases/{sqlDatabaseName}: get: operationId: SqlDatabases_Get tags: - Sql Databases description: Get a SqlDatabaseResource parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: '#/components/parameters/RootScopeParameter' - name: sqlDatabaseName in: path description: The name of the SqlDatabase portable resource resource required: true schema: type: string maxLength: 63 pattern: ^[A-Za-z]([-A-Za-z0-9]*[A-Za-z0-9])?$ responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/SqlDatabaseResource' default: description: An unexpected error response. content: application/json: schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Get a SqlDatabase resource: $ref: ./examples/SQLDatabases_Get.json summary: Sql databases get x-summary-source: derived put: operationId: SqlDatabases_CreateOrUpdate tags: - Sql Databases description: Create a SqlDatabaseResource parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: '#/components/parameters/RootScopeParameter' - name: sqlDatabaseName in: path description: The name of the SqlDatabase portable resource resource required: true schema: type: string maxLength: 63 pattern: ^[A-Za-z]([-A-Za-z0-9]*[A-Za-z0-9])?$ responses: '200': description: Resource 'SqlDatabaseResource' update operation succeeded content: application/json: schema: $ref: '#/components/schemas/SqlDatabaseResource' '201': description: Resource 'SqlDatabaseResource' create operation succeeded headers: Azure-AsyncOperation: description: A link to the status monitor schema: type: string Retry-After: description: The Retry-After header can indicate how long the client should wait before polling the operation status. schema: type: integer format: int32 content: application/json: schema: $ref: '#/components/schemas/SqlDatabaseResource' default: description: An unexpected error response. content: application/json: schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Create or update a SqlDatabase resource: $ref: ./examples/SQLDatabases_CreateOrUpdate.json x-ms-long-running-operation-options: final-state-via: azure-async-operation x-ms-long-running-operation: true requestBody: content: application/json: schema: $ref: '#/components/schemas/SqlDatabaseResource' description: Resource create parameters. required: true summary: Sql databases create or update x-summary-source: derived patch: operationId: SqlDatabases_Update tags: - Sql Databases description: Update a SqlDatabaseResource parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: '#/components/parameters/RootScopeParameter' - name: sqlDatabaseName in: path description: The name of the SqlDatabase portable resource resource required: true schema: type: string maxLength: 63 pattern: ^[A-Za-z]([-A-Za-z0-9]*[A-Za-z0-9])?$ responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/SqlDatabaseResource' '202': description: Resource update request accepted. headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string Retry-After: description: The Retry-After header can indicate how long the client should wait before polling the operation status. schema: type: integer format: int32 default: description: An unexpected error response. content: application/json: schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Update a SqlDatabase resource: $ref: ./examples/SQLDatabases_Update.json x-ms-long-running-operation-options: final-state-via: location x-ms-long-running-operation: true requestBody: content: application/json: schema: $ref: '#/components/schemas/SqlDatabaseResourceUpdate' description: The resource properties to be updated. required: true summary: Sql databases update x-summary-source: derived delete: operationId: SqlDatabases_Delete tags: - Sql Databases description: Delete a SqlDatabaseResource parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: '#/components/parameters/RootScopeParameter' - name: sqlDatabaseName in: path description: The name of the SqlDatabase portable resource resource required: true schema: type: string maxLength: 63 pattern: ^[A-Za-z]([-A-Za-z0-9]*[A-Za-z0-9])?$ responses: '202': description: Resource deletion accepted. headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string Retry-After: description: The Retry-After header can indicate how long the client should wait before polling the operation status. schema: type: integer format: int32 '204': description: Resource does not exist. default: description: An unexpected error response. content: application/json: schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Delete a SqlDatabase resource: $ref: ./examples/SQLDatabases_Delete.json x-ms-long-running-operation-options: final-state-via: location x-ms-long-running-operation: true summary: Sql databases delete x-summary-source: derived /{rootScope}/providers/Applications.Datastores/sqlDatabases/{sqlDatabaseName}/listSecrets: post: operationId: SqlDatabases_ListSecrets tags: - Sql Databases description: Lists secrets values for the specified SqlDatabase resource parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: '#/components/parameters/RootScopeParameter' - name: sqlDatabaseName in: path description: The name of the SqlDatabase portable resource resource required: true schema: type: string maxLength: 63 pattern: ^[A-Za-z]([-A-Za-z0-9]*[A-Za-z0-9])?$ responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/SqlDatabaseListSecretsResult' default: description: An unexpected error response. content: application/json: schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse requestBody: content: application/json: schema: type: object description: The content of the action request required: true summary: Sql databases list secrets x-summary-source: derived components: schemas: SqlDatabaseResourceListResult: type: object description: The response of a SqlDatabaseResource list operation. properties: value: type: array description: The SqlDatabaseResource items on this page items: $ref: '#/components/schemas/SqlDatabaseResource' nextLink: type: string format: uri description: The link to the next page of items required: - value EnvironmentCompute: type: object description: Represents backing compute resource properties: kind: type: string description: Discriminator property for EnvironmentCompute. resourceId: type: string description: The resource id of the compute resource for application environment. identity: $ref: '#/components/schemas/IdentitySettings' description: Configuration for supported external identity providers discriminator: propertyName: kind required: - kind OutputResource: type: object description: Properties of an output resource. properties: localId: type: string description: The logical identifier scoped to the owning Radius resource. This is only needed or used when a resource has a dependency relationship. LocalIDs do not have any particular format or meaning beyond being compared to determine dependency relationships. id: type: string description: The UCP resource ID of the underlying resource. radiusManaged: type: boolean description: Determines whether Radius manages the lifecycle of the underlying resource. RecipeStatus: type: object description: Recipe status at deployment time for a resource. properties: templateKind: type: string description: TemplateKind is the kind of the recipe template used by the portable resource upon deployment. templatePath: type: string description: TemplatePath is the path of the recipe consumed by the portable resource upon deployment. templateVersion: type: string description: TemplateVersion is the version number of the template. required: - templateKind - templatePath SqlDatabaseSecrets: type: object description: The secret values for the given SqlDatabase resource properties: password: type: string description: Password to use when connecting to the target Sql database connectionString: type: string description: Connection string used to connect to the target Sql database IdentitySettings: type: object description: IdentitySettings is the external identity setting. properties: kind: $ref: '#/components/schemas/IdentitySettingKind' description: kind of identity setting oidcIssuer: type: string description: The URI for your compute platform's OIDC issuer resource: type: string description: The resource ID of the provisioned identity managedIdentity: type: array description: The list of user assigned managed identities items: type: string required: - kind IdentitySettingKind: type: string description: IdentitySettingKind is the kind of supported external identity setting enum: - undefined - azure.com.workload - userAssigned - systemAssigned - systemAssignedUserAssigned x-ms-enum: name: IdentitySettingKind modelAsString: false values: - name: undefined value: undefined description: undefined identity - name: azure.com.workload value: azure.com.workload description: azure ad workload identity - name: userAssigned value: userAssigned description: User assigned managed identity - name: systemAssigned value: systemAssigned description: System assigned managed identity - name: systemAssignedUserAssigned value: systemAssignedUserAssigned description: System assigned and user assigned managed identity Recipe: type: object description: The recipe used to automatically deploy underlying infrastructure for a portable resource properties: name: type: string description: The name of the recipe within the environment to use parameters: type: object description: Key/value parameters to pass into the recipe at deployment required: - name ProvisioningState: type: string description: Provisioning state of the resource at the time the operation was called enum: - Creating - Updating - Deleting - Accepted - Provisioning - Succeeded - Failed - Canceled x-ms-enum: name: ProvisioningState modelAsString: false values: - name: Creating value: Creating description: The resource is being created - name: Updating value: Updating description: The resource is being updated - name: Deleting value: Deleting description: The resource is being deleted - name: Accepted value: Accepted description: The resource create request has been accepted - name: Provisioning value: Provisioning description: The resource is being provisioned - name: Succeeded value: Succeeded description: The resource has been successfully provisioned - name: Failed value: Failed description: The resource provisioning has failed - name: Canceled value: Canceled description: The resource provisioning has been canceled readOnly: true ResourceReference: type: object description: Describes a reference to an existing resource properties: id: type: string description: Resource id of an existing resource required: - id ResourceStatus: type: object description: Status of a resource. properties: compute: $ref: '#/components/schemas/EnvironmentCompute' description: The compute resource associated with the resource. recipe: $ref: '#/components/schemas/RecipeStatus' description: The recipe data at the time of deployment readOnly: true outputResources: type: array description: Properties of an output resource items: $ref: '#/components/schemas/OutputResource' x-ms-identifiers: [] SqlDatabaseListSecretsResult: type: object description: The secret values for the given SqlDatabase resource properties: password: type: string description: Password to use when connecting to the target Sql database connectionString: type: string description: Connection string used to connect to the target Sql database SqlDatabaseResource: type: object description: SqlDatabase portable resource properties: properties: $ref: '#/components/schemas/SqlDatabaseProperties' description: The resource-specific properties for this resource. x-ms-client-flatten: true x-ms-mutability: - read - create required: - properties allOf: - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource ResourceProvisioning: type: string description: Specifies how the underlying service/resource is provisioned and managed. Available values are 'recipe', where Radius manages the lifecycle of the resource through a Recipe, and 'manual', where a user manages the resource and provides the values. enum: - recipe - manual x-ms-enum: name: ResourceProvisioning modelAsString: false values: - name: recipe value: recipe description: The resource lifecycle will be managed by Radius - name: manual value: manual description: The resource lifecycle will be managed by the user SqlDatabaseResourceUpdate: type: object description: SqlDatabase portable resource allOf: - $ref: '#/components/schemas/Azure.ResourceManager.CommonTypes.TrackedResourceUpdate' SqlDatabaseProperties: type: object description: SqlDatabase properties properties: environment: type: string description: Fully qualified resource ID for the environment that the portable resource is linked to application: type: string description: Fully qualified resource ID for the application that the portable resource is consumed by (if applicable) provisioningState: $ref: '#/components/schemas/ProvisioningState' description: The status of the asynchronous operation. readOnly: true status: $ref: '#/components/schemas/ResourceStatus' description: Status of a resource. readOnly: true database: type: string description: The name of the Sql database. server: type: string description: The fully qualified domain name of the Sql database. port: type: integer format: int32 description: Port value of the target Sql database username: type: string description: Username to use when connecting to the target Sql database resources: type: array description: List of the resource IDs that support the SqlDatabase resource items: $ref: '#/components/schemas/ResourceReference' secrets: $ref: '#/components/schemas/SqlDatabaseSecrets' description: Secret values provided for the resource recipe: $ref: '#/components/schemas/Recipe' description: The recipe used to automatically deploy underlying infrastructure for the resource resourceProvisioning: $ref: '#/components/schemas/ResourceProvisioning' description: Specifies how the underlying service/resource is provisioned and managed. required: - environment Azure.ResourceManager.CommonTypes.TrackedResourceUpdate: type: object title: Tracked Resource description: The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location' properties: tags: type: object description: Resource tags. additionalProperties: type: string allOf: - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/Resource parameters: RootScopeParameter: name: rootScope in: path description: The scope in which the resource is present. UCP Scope is /planes/{planeType}/{planeName}/resourceGroup/{resourcegroupID} and Azure resource scope is /subscriptions/{subscriptionID}/resourceGroup/{resourcegroupID} required: true x-ms-parameter-location: client x-ms-skip-url-encoding: true schema: type: string minLength: 1 securitySchemes: azure_auth: type: oauth2 flows: implicit: scopes: user_impersonation: impersonate your user account authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize description: Azure Active Directory OAuth2 Flow.