Spark Configurations - List By Workspace

Service:

Synapse

API Version:

2021-06-01-preview

Liste as sparkConfigurations em um workspace.
Listar sparkConfigurations em um workspace.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sparkconfigurations?api-version=2021-06-01-preview

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string	A ID da assinatura de destino.
workspaceName	path	True	string	O nome do workspace.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	SparkConfigurationListResponse	OK.
Other Status Codes	ErrorResponse	Uma resposta de erro recebida do serviço Azure Synapse.

Exemplos

List sparkConfigurations in a workspace

Sample Request

HTTP

GET https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspace/sparkconfigurations?api-version=2021-06-01-preview

Java

/** Samples for SparkConfigurationsOperation ListByWorkspace. */
public final class Main {
    /*
     * x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/SparkConfigurations_ListByWorkspace.json
     */
    /**
     * Sample code: List sparkConfigurations in a workspace.
     *
     * @param manager Entry point to SynapseManager.
     */
    public static void listSparkConfigurationsInAWorkspace(com.azure.resourcemanager.synapse.SynapseManager manager) {
        manager
            .sparkConfigurationsOperations()
            .listByWorkspace("exampleResourceGroup", "exampleWorkspace", 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.synapse import SynapseManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-synapse
# USAGE
    python spark_configurations_list_by_workspace.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 = SynapseManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="12345678-1234-1234-1234-12345678abc",
    )

    response = client.spark_configurations.list_by_workspace(
        resource_group_name="exampleResourceGroup",
        workspace_name="exampleWorkspace",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/SparkConfigurations_ListByWorkspace.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 armsynapse_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/SparkConfigurations_ListByWorkspace.json
func ExampleSparkConfigurationsClient_NewListByWorkspacePager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewSparkConfigurationsClient().NewListByWorkspacePager("exampleResourceGroup", "exampleWorkspace", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.SparkConfigurationListResponse = armsynapse.SparkConfigurationListResponse{
		// 	Value: []*armsynapse.SparkConfigurationResource{
		// 		{
		// 			Name: to.Ptr("exampleSparkConfigurationName1"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sparkconfigurations"),
		// 			ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspace/sparkconfigurations/exampleSparkConfigurationName"),
		// 			Etag: to.Ptr("1500474f-0000-0200-0000-5cbe090d0000"),
		// 			Properties: &armsynapse.SparkConfigurationInfo{
		// 				Description: to.Ptr("test sparkconfiguration description1"),
		// 				Annotations: []*string{
		// 					to.Ptr("testAnnotation1"),
		// 					to.Ptr("testAnnotation2")},
		// 					ConfigMergeRule: map[string]*string{
		// 						"allowedNextOperations.spark.key1": to.Ptr("replace,delete"),
		// 						"allowedNextOperations.spark.key2": to.Ptr("replace,delete,append"),
		// 						"currentOperation.append.separator.spark.key1": to.Ptr("space"),
		// 						"currentOperation.append.separator.spark.key2": to.Ptr("comma"),
		// 						"currentOperation.spark.key1": to.Ptr("append"),
		// 						"currentOperation.spark.key2": to.Ptr("append"),
		// 					},
		// 					Configs: map[string]*string{
		// 						"prop1": to.Ptr("true"),
		// 						"prop2": to.Ptr("true"),
		// 						"prop3": to.Ptr("123"),
		// 					},
		// 					Created: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1970-01-01T00:00:00.000Z"); return t}()),
		// 					CreatedBy: to.Ptr("test@microsoft.com"),
		// 					Notes: to.Ptr("testNotes"),
		// 				},
		// 			},
		// 			{
		// 				Name: to.Ptr("exampleSparkConfigurationName2"),
		// 				Type: to.Ptr("Microsoft.Synapse/workspaces/sparkconfigurations"),
		// 				ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspace/sparkconfigurations/exampleSparkConfigurationName2"),
		// 				Etag: to.Ptr("1500474f-0000-0200-0000-5cbe090d0000"),
		// 				Properties: &armsynapse.SparkConfigurationInfo{
		// 					Description: to.Ptr("test sparkconfiguration description2"),
		// 					Annotations: []*string{
		// 						to.Ptr("testAnnotation1"),
		// 						to.Ptr("testAnnotation2")},
		// 						ConfigMergeRule: map[string]*string{
		// 							"allowedNextOperations.spark.key1": to.Ptr("replace,delete"),
		// 							"allowedNextOperations.spark.key2": to.Ptr("replace,delete,append"),
		// 							"currentOperation.append.separator.spark.key1": to.Ptr("space"),
		// 							"currentOperation.append.separator.spark.key2": to.Ptr("comma"),
		// 							"currentOperation.spark.key1": to.Ptr("append"),
		// 							"currentOperation.spark.key2": to.Ptr("append"),
		// 						},
		// 						Configs: map[string]*string{
		// 							"prop1": to.Ptr("true"),
		// 							"prop2": to.Ptr("true"),
		// 							"prop3": to.Ptr("123"),
		// 						},
		// 						Created: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1970-01-01T00:00:00.000Z"); return t}()),
		// 						CreatedBy: to.Ptr("test@microsoft.com"),
		// 						Notes: to.Ptr("testNotes"),
		// 					},
		// 			}},
		// 		}
	}
}

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 { SynapseManagementClient } = require("@azure/arm-synapse");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to List sparkConfigurations in a workspace.
 *
 * @summary List sparkConfigurations in a workspace.
 * x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/SparkConfigurations_ListByWorkspace.json
 */
async function listSparkConfigurationsInAWorkspace() {
  const subscriptionId =
    process.env["SYNAPSE_SUBSCRIPTION_ID"] || "12345678-1234-1234-1234-12345678abc";
  const resourceGroupName = process.env["SYNAPSE_RESOURCE_GROUP"] || "exampleResourceGroup";
  const workspaceName = "exampleWorkspace";
  const credential = new DefaultAzureCredential();
  const client = new SynapseManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.sparkConfigurations.listByWorkspace(
    resourceGroupName,
    workspaceName
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

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 System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Synapse;

// Generated from example definition: specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/SparkConfigurations_ListByWorkspace.json
// this example is just showing the usage of "SparkConfigurations_ListByWorkspace" 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 SynapseWorkspaceResource created on azure
// for more information of creating SynapseWorkspaceResource, please refer to the document of SynapseWorkspaceResource
string subscriptionId = "12345678-1234-1234-1234-12345678abc";
string resourceGroupName = "exampleResourceGroup";
string workspaceName = "exampleWorkspace";
ResourceIdentifier synapseWorkspaceResourceId = SynapseWorkspaceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, workspaceName);
SynapseWorkspaceResource synapseWorkspace = client.GetSynapseWorkspaceResource(synapseWorkspaceResourceId);

// get the collection of this SynapseSparkConfigurationResource
SynapseSparkConfigurationCollection collection = synapseWorkspace.GetSynapseSparkConfigurations();

// invoke the operation and iterate over the result
await foreach (SynapseSparkConfigurationResource item in collection.GetAllAsync())
{
    // the variable item 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
    SynapseSparkConfigurationData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

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

Date: Wed, 23 Oct 2020 21:33:05 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-reads: 14909
x-ms-request-id: f632df92-1140-4e19-9e19-0b1c8cbe393b
x-ms-correlation-request-id: f632df92-1140-4e19-9e19-0b1c8cbe393b

Response Body

{
  "value": [
    {
      "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspace/sparkconfigurations/exampleSparkConfigurationName",
      "name": "exampleSparkConfigurationName1",
      "type": "Microsoft.Synapse/workspaces/sparkconfigurations",
      "properties": {
        "description": "test sparkconfiguration description1",
        "configs": {
          "prop1": "true",
          "prop2": "true",
          "prop3": "123"
        },
        "annotations": [
          "testAnnotation1",
          "testAnnotation2"
        ],
        "notes": "testNotes",
        "createdBy": "test@microsoft.com",
        "created": "1970-01-01T00:00:00Z",
        "configMergeRule": {
          "currentOperation.spark.key1": "append",
          "currentOperation.append.separator.spark.key1": "space",
          "currentOperation.spark.key2": "append",
          "currentOperation.append.separator.spark.key2": "comma",
          "allowedNextOperations.spark.key1": "replace,delete",
          "allowedNextOperations.spark.key2": "replace,delete,append"
        }
      },
      "etag": "1500474f-0000-0200-0000-5cbe090d0000"
    },
    {
      "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspace/sparkconfigurations/exampleSparkConfigurationName2",
      "name": "exampleSparkConfigurationName2",
      "type": "Microsoft.Synapse/workspaces/sparkconfigurations",
      "properties": {
        "description": "test sparkconfiguration description2",
        "configs": {
          "prop1": "true",
          "prop2": "true",
          "prop3": "123"
        },
        "annotations": [
          "testAnnotation1",
          "testAnnotation2"
        ],
        "notes": "testNotes",
        "createdBy": "test@microsoft.com",
        "created": "1970-01-01T00:00:00Z",
        "configMergeRule": {
          "currentOperation.spark.key1": "append",
          "currentOperation.append.separator.spark.key1": "space",
          "currentOperation.spark.key2": "append",
          "currentOperation.append.separator.spark.key2": "comma",
          "allowedNextOperations.spark.key1": "replace,delete",
          "allowedNextOperations.spark.key2": "replace,delete,append"
        }
      },
      "etag": "1500474f-0000-0200-0000-5cbe090d0000"
    }
  ],
  "nextLink": ""
}

Definições

Nome	Description
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
SparkConfigurationListResponse	Uma lista de recursos sparkConfiguration.
SparkConfigurationResource	Detalhes da resposta do SparkConfiguration

ErrorAdditionalInfo

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

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

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

SparkConfigurationListResponse

Uma lista de recursos sparkConfiguration.

Nome	Tipo	Description
nextLink	string	O link para a próxima página de resultados, se houver resultados restantes.
value	SparkConfigurationResource[]	Lista de SparkConfiguration.

SparkConfigurationResource

Detalhes da resposta do SparkConfiguration

Nome	Tipo	Description
etag	string	Etag de recurso.
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.annotations	string[]	Anotações para SparkConfiguration.
properties.configMergeRule	object	Configurações de mesclagem do SparkConfiguration.
properties.configs	object	Configurações do SparkConfiguration.
properties.created	string	O carimbo de data/hora da criação de recursos.
properties.createdBy	string	A identidade que criou o recurso.
properties.description	string	Descrição sobre o SparkConfiguration.
properties.notes	string	Anotações adicionais.
type	string	Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"