Static Sites - Get Database Connection With Details

Servicio:

App Service

Versión de la API:

2024-11-01

Devuelve los detalles de una conexión de base de datos para un sitio estático por nombre.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/databaseConnections/{databaseConnectionName}/show?api-version=2024-11-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
databaseConnectionName	path	True	string pattern: ^[a-zA-Z0-9]+$	Nombre de la conexión de base de datos.
name	path	True	string	Nombre del sitio estático
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Nombre del grupo de recursos al que pertenece el recurso.
subscriptionId	path	True	string	Su identificador de suscripción de Azure. Se trata de una cadena con formato GUID (por ejemplo, 000000000-00000-0000-0000-00000000000000).
api-version	query	True	string	Versión de la API

Respuestas

Nombre	Tipo	Description
200 OK	DatabaseConnection	De acuerdo
Other Status Codes	DefaultErrorResponse	Respuesta de error de App Service.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Get details of database connections for the static site.

Solicitud de ejemplo

HTTP

POST https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/databaseConnections/default/show?api-version=2024-11-01

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.AppService.Models;
using Azure.ResourceManager.AppService;

// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/GetStaticSiteDatabaseConnectionWithDetails.json
// this example is just showing the usage of "StaticSites_GetDatabaseConnectionWithDetails" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this StaticSiteDatabaseConnectionResource created on azure
// for more information of creating StaticSiteDatabaseConnectionResource, please refer to the document of StaticSiteDatabaseConnectionResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "rg";
string name = "testStaticSite0";
string databaseConnectionName = "default";
ResourceIdentifier staticSiteDatabaseConnectionResourceId = StaticSiteDatabaseConnectionResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name, databaseConnectionName);
StaticSiteDatabaseConnectionResource staticSiteDatabaseConnection = client.GetStaticSiteDatabaseConnectionResource(staticSiteDatabaseConnectionResourceId);

// invoke the operation
StaticSiteDatabaseConnectionResource result = await staticSiteDatabaseConnection.GetDatabaseConnectionWithDetailsAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
StaticSiteDatabaseConnectionData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Respuesta de muestra

status code:

200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/databaseConnections/default",
  "name": "default",
  "type": "Microsoft.Web/staticSites/databaseConnections",
  "properties": {
    "resourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/databaseRG/providers/Microsoft.DocumentDB/databaseAccounts/exampleDatabaseName",
    "connectionIdentity": "SystemAssigned",
    "connectionString": "AccountEndpoint=https://exampleDatabaseName.documents.azure.com:443/;Database=mydb;",
    "region": "West US 2",
    "configurationFiles": [
      {
        "fileName": "staticwebapp.database.config.json",
        "contents": "base64encodeddatabaseconfiguration",
        "type": "configuration"
      },
      {
        "fileName": "staticwebapp.database.schema.gql",
        "contents": "base64encodeddatabasegraphqlschema",
        "type": "graphqlschema"
      }
    ]
  }
}

Definiciones

Nombre	Description
DatabaseConnection	Recurso de conexión de base de datos de sitio estático.
DefaultErrorResponse	Respuesta de error de App Service.
Details
Error	Modelo de error.
StaticSiteDatabaseConnectionConfigurationFileOverview	Un archivo de configuración de conexión de base de datos

DatabaseConnection

Object

Recurso de conexión de base de datos de sitio estático.

Nombre	Tipo	Description
id	string	Identificador de recurso.
kind	string	Tipo de recurso.
name	string	Nombre del recurso.
properties.configurationFiles	StaticSiteDatabaseConnectionConfigurationFileOverview[]	Lista de archivos de configuración asociados a esta conexión de base de datos.
properties.connectionIdentity	string	Si está presente, la identidad se usa junto con la cadena de conexión para conectarse a la base de datos. El uso de la identidad administrada asignada por el sistema se indica con la cadena "SystemAssigned", mientras que el uso de una identidad administrada asignada por el usuario se indica con el identificador de recurso del recurso de identidad administrada.
properties.connectionString	string	Cadena de conexión que se va a usar para conectarse a la base de datos.
properties.region	string	Región del recurso de base de datos.
properties.resourceId	string	Identificador de recurso de la base de datos.
type	string	Tipo de recurso.

DefaultErrorResponse

Object

Respuesta de error de App Service.

Nombre	Tipo	Description
error	Error	Modelo de error.

Details

Object

Nombre	Tipo	Description
code	string	Cadena estandarizada para identificar mediante programación el error.
message	string	Descripción detallada del error e información de depuración.
target	string	Descripción detallada del error e información de depuración.

Error

Object

Modelo de error.

Nombre	Tipo	Description
code	string	Cadena estandarizada para identificar mediante programación el error.
details	Details[]	Errores detallados.
innererror	string	Más información para depurar el error.
message	string	Descripción detallada del error e información de depuración.
target	string	Descripción detallada del error e información de depuración.

StaticSiteDatabaseConnectionConfigurationFileOverview

Object

Un archivo de configuración de conexión de base de datos

Nombre	Tipo	Description
contents	string	Codificación Base64 del contenido del archivo.
fileName	string	Nombre del archivo de configuración.
type	string	Tipo de archivo de configuración.