Scripts - Get

Serviço:

Azure Kusto

Versão da API:

2024-04-13

Obtém um script de banco de dados do cluster Kusto.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/scripts/{scriptName}?api-version=2024-04-13

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
clusterName	path	True	string pattern: ^.*$	O nome do cluster Kusto.
databaseName	path	True	string pattern: ^.*$	O nome do banco de dados no cluster Kusto.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
scriptName	path	True	string pattern: ^.*$	O nome do script de banco de dados kusto.
subscriptionId	path	True	string minLength: 1	A ID da assinatura de destino.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	Script	O objeto de script do banco de dados do cluster Kusto.
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Exemplos

KustoScriptsGet

Solicitação de exemplo

HTTP

GET https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/clusters/kustoCluster/databases/Kustodatabase8/scripts/kustoScript?api-version=2024-04-13

Java

/**
 * Samples for Scripts Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2024-04-13/examples/KustoScriptsGet.json
     */
    /**
     * Sample code: KustoScriptsGet.
     * 
     * @param manager Entry point to KustoManager.
     */
    public static void kustoScriptsGet(com.azure.resourcemanager.kusto.KustoManager manager) {
        manager.scripts().getWithResponse("kustorptest", "kustoCluster", "Kustodatabase8", "kustoScript",
            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.kusto import KustoManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-kusto
# USAGE
    python kusto_scripts_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 = KustoManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="12345678-1234-1234-1234-123456789098",
    )

    response = client.scripts.get(
        resource_group_name="kustorptest",
        cluster_name="kustoCluster",
        database_name="Kustodatabase8",
        script_name="kustoScript",
    )
    print(response)


# x-ms-original-file: specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2024-04-13/examples/KustoScriptsGet.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 armkusto_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/kusto/armkusto/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b8adce17dc500f338f86f18af30aac61dcb71c5f/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2024-04-13/examples/KustoScriptsGet.json
func ExampleScriptsClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewScriptsClient().Get(ctx, "kustorptest", "kustoCluster", "Kustodatabase8", "kustoScript", 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.Script = armkusto.Script{
	// 	Name: to.Ptr("kustoCluster/Kustodatabase8/kustoScript"),
	// 	Type: to.Ptr("Microsoft.Kusto/Clusters/Databases/Scripts"),
	// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/Databases/Kustodatabase8/Scripts/kustoScript"),
	// 	Properties: &armkusto.ScriptProperties{
	// 		ContinueOnErrors: to.Ptr(true),
	// 		ForceUpdateTag: to.Ptr("2bcf3c21-ffd1-4444-b9dd-e52e00ee53fe"),
	// 		PrincipalPermissionsAction: to.Ptr(armkusto.PrincipalPermissionsActionRemovePermissionOnScriptCompletion),
	// 		ScriptLevel: to.Ptr(armkusto.ScriptLevelDatabase),
	// 		ScriptURL: to.Ptr("https://mysa.blob.core.windows.net/container/script.txt"),
	// 	},
	// 	SystemData: &armkusto.SystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-29T15:06:54.275Z"); return t}()),
	// 		CreatedBy: to.Ptr("user@microsoft.com"),
	// 		CreatedByType: to.Ptr(armkusto.CreatedByTypeUser),
	// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-29T15:06:54.275Z"); return t}()),
	// 		LastModifiedBy: to.Ptr("user@microsoft.com"),
	// 		LastModifiedByType: to.Ptr(armkusto.CreatedByTypeUser),
	// 	},
	// }
}

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 { KustoManagementClient } = require("@azure/arm-kusto");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Gets a Kusto cluster database script.
 *
 * @summary Gets a Kusto cluster database script.
 * x-ms-original-file: specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2024-04-13/examples/KustoScriptsGet.json
 */
async function kustoScriptsGet() {
  const subscriptionId =
    process.env["KUSTO_SUBSCRIPTION_ID"] || "12345678-1234-1234-1234-123456789098";
  const resourceGroupName = process.env["KUSTO_RESOURCE_GROUP"] || "kustorptest";
  const clusterName = "kustoCluster";
  const databaseName = "Kustodatabase8";
  const scriptName = "kustoScript";
  const credential = new DefaultAzureCredential();
  const client = new KustoManagementClient(credential, subscriptionId);
  const result = await client.scripts.get(resourceGroupName, clusterName, databaseName, scriptName);
  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

dotnet

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

// Generated from example definition: specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2024-04-13/examples/KustoScriptsGet.json
// this example is just showing the usage of "Scripts_Get" 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 KustoDatabaseResource created on azure
// for more information of creating KustoDatabaseResource, please refer to the document of KustoDatabaseResource
string subscriptionId = "12345678-1234-1234-1234-123456789098";
string resourceGroupName = "kustorptest";
string clusterName = "kustoCluster";
string databaseName = "Kustodatabase8";
ResourceIdentifier kustoDatabaseResourceId = KustoDatabaseResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, clusterName, databaseName);
KustoDatabaseResource kustoDatabase = client.GetKustoDatabaseResource(kustoDatabaseResourceId);

// get the collection of this KustoScriptResource
KustoScriptCollection collection = kustoDatabase.GetKustoScripts();

// invoke the operation
string scriptName = "kustoScript";
NullableResponse<KustoScriptResource> response = await collection.GetIfExistsAsync(scriptName);
KustoScriptResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // 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
    KustoScriptData 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

Resposta de exemplo

Código de status:

200

{
  "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/Databases/Kustodatabase8/Scripts/kustoScript",
  "name": "kustoCluster/Kustodatabase8/kustoScript",
  "type": "Microsoft.Kusto/Clusters/Databases/Scripts",
  "properties": {
    "scriptUrl": "https://mysa.blob.core.windows.net/container/script.txt",
    "forceUpdateTag": "2bcf3c21-ffd1-4444-b9dd-e52e00ee53fe",
    "continueOnErrors": true,
    "scriptLevel": "Database",
    "principalPermissionsAction": "RemovePermissionOnScriptCompletion"
  },
  "systemData": {
    "createdBy": "user@microsoft.com",
    "createdByType": "User",
    "createdAt": "2021-06-29T15:06:54.2757906Z",
    "lastModifiedBy": "user@microsoft.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-06-29T15:06:54.2757906Z"
  }
}

Definições

Nome	Description
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
PrincipalPermissionsAction	Indica se as permissões para o chamador de script são mantidas após a conclusão do script.
ProvisioningState	O estado provisionado do recurso.
Script	Classe que representa um script de banco de dados.
ScriptLevel	Diferencia entre o tipo de comandos de script incluídos – Banco de dados ou Cluster. O padrão é o Banco de Dados.
systemData	Metadados relativos à criação e última modificação do recurso.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

PrincipalPermissionsAction

Enumeração

Indica se as permissões para o chamador de script são mantidas após a conclusão do script.

Valor	Description
RemovePermissionOnScriptCompletion
RetainPermissionOnScriptCompletion

ProvisioningState

Enumeração

O estado provisionado do recurso.

Valor	Description
Canceled
Creating
Deleting
Failed
Moving
Running
Succeeded

Script

Objeto

Classe que representa um script de banco de dados.

Nome	Tipo	Valor padrão	Description
id	string		ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		O nome do recurso
properties.continueOnErrors	boolean	False	Sinalizador que indica se deve continuar se um dos comandos falhar.
properties.forceUpdateTag	string		Uma cadeia de caracteres exclusiva. Se alterado, o script será aplicado novamente.
properties.principalPermissionsAction	PrincipalPermissionsAction		Indica se as permissões para o chamador de script são mantidas após a conclusão do script.
properties.provisioningState	ProvisioningState		O estado provisionado do recurso.
properties.scriptContent	string		O conteúdo do script. Essa propriedade deve ser usada quando o script for fornecido embutido e não por meio de um arquivo em uma SA. Não deve ser usado junto com as propriedades scriptUrl E scriptUrlSasToken.
properties.scriptLevel	ScriptLevel		Diferencia entre o tipo de comandos de script incluídos – Banco de dados ou Cluster. O padrão é o Banco de Dados.
properties.scriptUrl	string		A URL para o arquivo de blob de script KQL. Não deve ser usado junto com a propriedade scriptContent
properties.scriptUrlSasToken	string		O token SaS que fornece acesso de leitura ao arquivo que contém o script. Deve ser fornecido ao usar a propriedade scriptUrl.
systemData	systemData		Metadados relativos à criação e última modificação do recurso.
type	string		O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

ScriptLevel

Enumeração

Diferencia entre o tipo de comandos de script incluídos – Banco de dados ou Cluster. O padrão é o Banco de Dados.

Valor	Description
Cluster
Database

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.