Clusters - Create Or Update

Service:

Stream Analytics

API Version:

2020-03-01

Creates a Stream Analytics Cluster or replaces an already existing cluster.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/clusters/{clusterName}?api-version=2020-03-01

URI Parameters

Name	In	Required	Type	Description
clusterName	path	True	string	The name of the cluster.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+$	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Header

Name	Required	Type	Description
If-Match		string	The ETag of the resource. Omit this value to always overwrite the current record set. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
If-None-Match		string	Set to '*' to allow a new resource to be created, but to prevent updating an existing record set. Other values will result in a 412 Pre-condition Failed response.

Request Body

Name	Type	Description
location	string	The geo-location where the resource lives
sku	ClusterSku	The SKU of the cluster. This determines the size/capacity of the cluster. Required on PUT (CreateOrUpdate) requests.
tags	object	Resource tags.

Responses

Name	Type	Description
200 OK	Cluster	The cluster was successfully created or replaced.
201 Created	Cluster	The cluster was successfully created or replaced.
Other Status Codes	Error	Error.

Security

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Create a new cluster

Sample request

HTTP

PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/clusters/An Example Cluster?api-version=2020-03-01

{
  "location": "North US",
  "tags": {
    "key": "value"
  },
  "sku": {
    "name": "Default",
    "capacity": 48
  }
}

Java

import com.azure.resourcemanager.streamanalytics.models.ClusterSku;
import com.azure.resourcemanager.streamanalytics.models.ClusterSkuName;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for Clusters CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/
     * Cluster_Create.json
     */
    /**
     * Sample code: Create a new cluster.
     * 
     * @param manager Entry point to StreamAnalyticsManager.
     */
    public static void createANewCluster(com.azure.resourcemanager.streamanalytics.StreamAnalyticsManager manager) {
        manager.clusters().define("An Example Cluster").withRegion("North US").withExistingResourceGroup("sjrg")
            .withTags(mapOf("key", "fakeTokenPlaceholder"))
            .withSku(new ClusterSku().withName(ClusterSkuName.DEFAULT).withCapacity(48)).create();
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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 armstreamanalytics_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/streamanalytics/armstreamanalytics"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Cluster_Create.json
func ExampleClustersClient_BeginCreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armstreamanalytics.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewClustersClient().BeginCreateOrUpdate(ctx, "sjrg", "An Example Cluster", armstreamanalytics.Cluster{
		Location: to.Ptr("North US"),
		Tags: map[string]*string{
			"key": to.Ptr("value"),
		},
		SKU: &armstreamanalytics.ClusterSKU{
			Name:     to.Ptr(armstreamanalytics.ClusterSKUNameDefault),
			Capacity: to.Ptr[int32](48),
		},
	}, &armstreamanalytics.ClustersClientBeginCreateOrUpdateOptions{IfMatch: nil,
		IfNoneMatch: nil,
	})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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.Cluster = armstreamanalytics.Cluster{
	// 	Name: to.Ptr("An Example Cluster"),
	// 	Type: to.Ptr("Microsoft.StreamAnalytics/clusters"),
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/clusters/AnExampleStreamingCluster"),
	// 	Location: to.Ptr("North US"),
	// 	Tags: map[string]*string{
	// 		"key": to.Ptr("value"),
	// 	},
	// 	Etag: to.Ptr("F86B9B70-D5B1-451D-AFC8-0B42D4729B8C"),
	// 	Properties: &armstreamanalytics.ClusterProperties{
	// 		CapacityAllocated: to.Ptr[int32](0),
	// 		CapacityAssigned: to.Ptr[int32](0),
	// 		ClusterID: to.Ptr("B01C67EF-4739-4DDD-9FB2-427EB43DE839"),
	// 		CreatedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-25T01:00:00.000Z"); return t}()),
	// 		ProvisioningState: to.Ptr(armstreamanalytics.ClusterProvisioningStateSucceeded),
	// 	},
	// 	SKU: &armstreamanalytics.ClusterSKU{
	// 		Name: to.Ptr(armstreamanalytics.ClusterSKUNameDefault),
	// 		Capacity: to.Ptr[int32](48),
	// 	},
	// }
}

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

/**
 * This sample demonstrates how to Creates a Stream Analytics Cluster or replaces an already existing cluster.
 *
 * @summary Creates a Stream Analytics Cluster or replaces an already existing cluster.
 * x-ms-original-file: specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Cluster_Create.json
 */
async function createANewCluster() {
  const subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = "sjrg";
  const clusterName = "An Example Cluster";
  const cluster = {
    location: "North US",
    sku: { name: "Default", capacity: 48 },
    tags: { key: "value" },
  };
  const credential = new DefaultAzureCredential();
  const client = new StreamAnalyticsManagementClient(credential, subscriptionId);
  const result = await client.clusters.beginCreateOrUpdateAndWait(
    resourceGroupName,
    clusterName,
    cluster
  );
  console.log(result);
}

createANewCluster().catch(console.error);

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/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/clusters/AnExampleStreamingCluster",
  "name": "An Example Cluster",
  "type": "Microsoft.StreamAnalytics/clusters",
  "location": "North US",
  "tags": {
    "key": "value"
  },
  "sku": {
    "name": "Default",
    "capacity": 48
  },
  "properties": {
    "createdDate": "2020-01-25T01:00:00Z",
    "clusterId": "B01C67EF-4739-4DDD-9FB2-427EB43DE839",
    "provisioningState": "Succeeded",
    "capacityAllocated": 0,
    "capacityAssigned": 0
  },
  "etag": "F86B9B70-D5B1-451D-AFC8-0B42D4729B8C"
}

Status code:

201

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/clusters/AnExampleStreamingCluster",
  "name": "An Example Cluster",
  "type": "Microsoft.StreamAnalytics/clusters",
  "location": "North US",
  "tags": {
    "key": "value"
  },
  "sku": {
    "name": "Default",
    "capacity": 48
  },
  "properties": {
    "createdDate": "2020-01-25T01:00:00Z",
    "clusterId": "B01C67EF-4739-4DDD-9FB2-427EB43DE839",
    "provisioningState": "Succeeded",
    "capacityAllocated": 0,
    "capacityAssigned": 0
  },
  "etag": "F86B9B70-D5B1-451D-AFC8-0B42D4729B8C"
}

Definitions

Name	Description
Cluster	A Stream Analytics Cluster object
ClusterProvisioningState	The status of the cluster provisioning. The three terminal states are: Succeeded, Failed and Canceled
ClusterSku	The SKU of the cluster. This determines the size/capacity of the cluster. Required on PUT (CreateOrUpdate) requests.
ClusterSkuName	Specifies the SKU name of the cluster. Required on PUT (CreateOrUpdate) requests.
Error	Common error representation.

Cluster

Object

A Stream Analytics Cluster object

Name	Type	Description
etag	string	The current entity tag for the cluster. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.
id	string	Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	The geo-location where the resource lives
name	string	The name of the resource
properties.capacityAllocated	integer (int32)	Represents the number of streaming units currently being used on the cluster.
properties.capacityAssigned	integer (int32)	Represents the sum of the SUs of all streaming jobs associated with the cluster. If all of the jobs were running, this would be the capacity allocated.
properties.clusterId	string	Unique identifier for the cluster.
properties.createdDate	string (date-time)	The date this cluster was created.
properties.provisioningState	ClusterProvisioningState	The status of the cluster provisioning. The three terminal states are: Succeeded, Failed and Canceled
sku	ClusterSku	The SKU of the cluster. This determines the size/capacity of the cluster. Required on PUT (CreateOrUpdate) requests.
tags	object	Resource tags.
type	string	The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

ClusterProvisioningState

Enumeration

The status of the cluster provisioning. The three terminal states are: Succeeded, Failed and Canceled

Value	Description
Succeeded	The cluster provisioning succeeded.
Failed	The cluster provisioning failed.
Canceled	The cluster provisioning was canceled.
InProgress	The cluster provisioning was inprogress.

ClusterSku

Object

The SKU of the cluster. This determines the size/capacity of the cluster. Required on PUT (CreateOrUpdate) requests.

Name	Type	Description
capacity	integer (int32) minimum: 36 maximum: 396	Denotes the number of streaming units the cluster can support. Valid values for this property are multiples of 36 with a minimum value of 36 and maximum value of 216. Required on PUT (CreateOrUpdate) requests.
name	ClusterSkuName	Specifies the SKU name of the cluster. Required on PUT (CreateOrUpdate) requests.

ClusterSkuName

Enumeration

Specifies the SKU name of the cluster. Required on PUT (CreateOrUpdate) requests.

Value	Description
Default	The default SKU.

Error

Object

Common error representation.

Name	Type	Description
error	Error	Error definition properties.