Sql Resources - Get Sql Stored Procedure

Service:

Cosmos DB Resource Provider

API Version:

2023-11-15

Obtient la sql storedProcedure sous un compte de base de données Azure Cosmos DB existant.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/storedProcedures/{storedProcedureName}?api-version=2023-11-15

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
accountName	path	True	string	Nom du compte de base de données Cosmos DB. Regex pattern: ^[a-z0-9]+(-[a-z0-9]+)*
containerName	path	True	string	Nom du conteneur Cosmos DB.
databaseName	path	True	string	Nom de la base de données Cosmos DB.
resourceGroupName	path	True	string	Nom du groupe de ressources. Le nom ne respecte pas la casse.
storedProcedureName	path	True	string	Nom de la procédure stockée Cosmos DB.
subscriptionId	path	True	string	ID de l’abonnement cible.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	SqlStoredProcedureGetResults	La propriété SQL storedProcedure a été récupérée avec succès.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

CosmosDBSqlStoredProcedureGet

Sample Request

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rgName/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/containers/containerName/storedProcedures/storedProcedureName?api-version=2023-11-15

Java

/**
 * Samples for SqlResources GetSqlStoredProcedure.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/
     * CosmosDBSqlStoredProcedureGet.json
     */
    /**
     * Sample code: CosmosDBSqlStoredProcedureGet.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void cosmosDBSqlStoredProcedureGet(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cosmosDBAccounts().manager().serviceClient().getSqlResources().getSqlStoredProcedureWithResponse("rgName",
            "ddb1", "databaseName", "containerName", "storedProcedureName", com.azure.core.util.Context.NONE);
    }
}

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

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.cosmosdb import CosmosDBManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cosmosdb
# USAGE
    python cosmos_db_sql_stored_procedure_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = CosmosDBManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.sql_resources.get_sql_stored_procedure(
        resource_group_name="rgName",
        account_name="ddb1",
        database_name="databaseName",
        container_name="containerName",
        stored_procedure_name="storedProcedureName",
    )
    print(response)


# x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlStoredProcedureGet.json
if __name__ == "__main__":
    main()

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

Go

package armcosmos_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cosmos/armcosmos/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/41e4538ed7bb3ceac3c1322c9455a0812ed110ac/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlStoredProcedureGet.json
func ExampleSQLResourcesClient_GetSQLStoredProcedure() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcosmos.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSQLResourcesClient().GetSQLStoredProcedure(ctx, "rgName", "ddb1", "databaseName", "containerName", "storedProcedureName", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SQLStoredProcedureGetResults = armcosmos.SQLStoredProcedureGetResults{
	// 	Name: to.Ptr("storedProcedureName"),
	// 	Type: to.Ptr("Microsoft.DocumentDB/databaseAccounts/sqlDatabases/sqlContainers/sqlStoredProcedures"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/sqlContainers/containerName/sqlStoredProcedures/storedProcedureName"),
	// 	Properties: &armcosmos.SQLStoredProcedureGetProperties{
	// 		Resource: &armcosmos.SQLStoredProcedureGetPropertiesResource{
	// 			Etag: to.Ptr("\"00005900-0000-0000-0000-56f9a2630000\""),
	// 			Rid: to.Ptr("PD5DALigDgw="),
	// 			Ts: to.Ptr[float32](1459200611),
	// 			Body: to.Ptr("body"),
	// 			ID: to.Ptr("storedProcedureName"),
	// 		},
	// 	},
	// }
}

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

JavaScript

const { CosmosDBManagementClient } = require("@azure/arm-cosmosdb");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets the SQL storedProcedure under an existing Azure Cosmos DB database account.
 *
 * @summary Gets the SQL storedProcedure under an existing Azure Cosmos DB database account.
 * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlStoredProcedureGet.json
 */
async function cosmosDbSqlStoredProcedureGet() {
  const subscriptionId = process.env["COSMOSDB_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["COSMOSDB_RESOURCE_GROUP"] || "rgName";
  const accountName = "ddb1";
  const databaseName = "databaseName";
  const containerName = "containerName";
  const storedProcedureName = "storedProcedureName";
  const credential = new DefaultAzureCredential();
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const result = await client.sqlResources.getSqlStoredProcedure(
    resourceGroupName,
    accountName,
    databaseName,
    containerName,
    storedProcedureName,
  );
  console.log(result);
}

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

Sample Response

Status code:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/sqlContainers/containerName/sqlStoredProcedures/storedProcedureName",
  "name": "storedProcedureName",
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/sqlContainers/sqlStoredProcedures",
  "properties": {
    "resource": {
      "id": "storedProcedureName",
      "body": "body",
      "_rid": "PD5DALigDgw=",
      "_ts": 1459200611,
      "_etag": "\"00005900-0000-0000-0000-56f9a2630000\""
    }
  }
}

Définitions

Nom	Description
Resource
SqlStoredProcedureGetResults	Une procédure stockée Azure Cosmos DB.

Resource

Nom	Type	Description
_etag	string	Propriété générée par le système représentant l’etag de ressources requise pour le contrôle d’accès concurrentiel optimiste.
_rid	string	Propriété générée par le système. Un identificateur unique.
_ts	number	Propriété générée par le système qui indique le dernier horodatage mis à jour de la ressource.
body	string	Corps de la procédure stockée
id	string	Nom de la procédure stockée SQL Cosmos DB

SqlStoredProcedureGetResults

Une procédure stockée Azure Cosmos DB.

Nom	Type	Description
id	string	Identificateur de ressource unique de la ressource ARM.
location	string	Emplacement du groupe de ressources auquel appartient la ressource.
name	string	Nom de la ressource ARM.
properties.resource	Resource
tags	object	Les balises sont une liste de paires clé-valeur qui décrivent la ressource. Ces balises peuvent servir à l’affichage et au regroupement des ressources (parmi tous les groupes de ressources). Un maximum de 15 balises peut être fourni pour une ressource. Chaque balise doit disposer d’une clé de 128 caractères maximum et d’une valeur de 256 caractères maximum. Par exemple, l’expérience par défaut pour un type de modèle est définie avec « defaultExperience » : « Cassandra ». Les valeurs « defaultExperience » actuelles incluent également « Table », « Graph », « DocumentDB » et « MongoDB ».
type	string	Type de ressource Azure.