Reference Data Sets - Create Or Update

Reference

Service:: Time Series Insights

API Version:: 2020-05-15

Vytvořte nebo aktualizujte referenční datovou sadu v zadaném prostředí.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}/referenceDataSets/{referenceDataSetName}?api-version=2020-05-15

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
environmentName	path	True	string	Název prostředí Time Series Insights přidruženého k zadané skupině prostředků.
referenceDataSetName	path	True	string	Název referenční sady dat. Regex pattern: `^[A-Za-z0-9]`
resourceGroupName	path	True	string	Název skupiny prostředků Azure.
subscriptionId	path	True	string	ID předplatného Azure.
api-version	query	True	string	Verze rozhraní API, která se má použít s požadavkem klienta.

Text požadavku

Name	Vyžadováno	Typ	Description
location	True	string	Umístění prostředku.
properties.keyProperties	True	ReferenceDataSetKeyProperty[]	Seznam klíčových vlastností referenční sady dat.
properties.dataStringComparisonBehavior		DataStringComparisonBehavior	Chování porovnání klíče referenční sady dat lze nastavit pomocí této vlastnosti. Ve výchozím nastavení je hodnota "Pořadové číslo", což znamená, že při spojování referenčních dat s událostmi nebo při přidávání nových referenčních dat se provede porovnání klíčů rozlišujících malá a velká písmena. Při nastavení ordinalIgnoreCase se použije porovnání nerozlišující malá a velká písmena.
tags		object	Páry klíč-hodnota dalších vlastností prostředku.

Odpovědi

Name	Typ	Description
200 OK	ReferenceDataSetResource	Existující definice referenční sady dat byla úspěšně aktualizována.
201 Created	ReferenceDataSetResource	Referenční datová sada byla úspěšně vytvořena.
Other Status Codes	CloudError	HTTP 400 (Chybný požadavek): Zadaný text požadavku referenční sady dat je neplatný. Podrobnosti najdete v kódu chyby a zprávě v odpovědi.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

Scopes

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

ReferenceDataSetsCreate

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/environments/env1/referenceDataSets/rds1?api-version=2020-05-15

{
  "location": "West US",
  "properties": {
    "keyProperties": [
      {
        "name": "DeviceId1",
        "type": "String"
      },
      {
        "name": "DeviceFloor",
        "type": "Double"
      }
    ]
  }
}

import com.azure.resourcemanager.timeseriesinsights.models.ReferenceDataKeyPropertyType;
import com.azure.resourcemanager.timeseriesinsights.models.ReferenceDataSetKeyProperty;
import java.util.Arrays;

/** Samples for ReferenceDataSets CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/ReferenceDataSetsCreate.json
     */
    /**
     * Sample code: ReferenceDataSetsCreate.
     *
     * @param manager Entry point to TimeSeriesInsightsManager.
     */
    public static void referenceDataSetsCreate(
        com.azure.resourcemanager.timeseriesinsights.TimeSeriesInsightsManager manager) {
        manager
            .referenceDataSets()
            .define("rds1")
            .withRegion("West US")
            .withExistingEnvironment("rg1", "env1")
            .withKeyProperties(
                Arrays
                    .asList(
                        new ReferenceDataSetKeyProperty()
                            .withName("DeviceId1")
                            .withType(ReferenceDataKeyPropertyType.STRING),
                        new ReferenceDataSetKeyProperty()
                            .withName("DeviceFloor")
                            .withType(ReferenceDataKeyPropertyType.DOUBLE)))
            .create();
    }
}

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

package armtimeseriesinsights_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/timeseriesinsights/armtimeseriesinsights"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/ReferenceDataSetsCreate.json
func ExampleReferenceDataSetsClient_CreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armtimeseriesinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewReferenceDataSetsClient().CreateOrUpdate(ctx, "rg1", "env1", "rds1", armtimeseriesinsights.ReferenceDataSetCreateOrUpdateParameters{
		Location: to.Ptr("West US"),
		Properties: &armtimeseriesinsights.ReferenceDataSetCreationProperties{
			KeyProperties: []*armtimeseriesinsights.ReferenceDataSetKeyProperty{
				{
					Name: to.Ptr("DeviceId1"),
					Type: to.Ptr(armtimeseriesinsights.ReferenceDataKeyPropertyTypeString),
				},
				{
					Name: to.Ptr("DeviceFloor"),
					Type: to.Ptr(armtimeseriesinsights.ReferenceDataKeyPropertyTypeDouble),
				}},
		},
	}, 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.ReferenceDataSetResource = armtimeseriesinsights.ReferenceDataSetResource{
	// 	Name: to.Ptr("rds1"),
	// 	Type: to.Ptr("Microsoft.TimeSeriesInsights/Environments/ReferenceDataSets"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/referenceDataSets/rds1"),
	// 	Location: to.Ptr("West US"),
	// 	Tags: map[string]*string{
	// 	},
	// 	Properties: &armtimeseriesinsights.ReferenceDataSetResourceProperties{
	// 		KeyProperties: []*armtimeseriesinsights.ReferenceDataSetKeyProperty{
	// 			{
	// 				Name: to.Ptr("DeviceId1"),
	// 				Type: to.Ptr(armtimeseriesinsights.ReferenceDataKeyPropertyTypeString),
	// 			},
	// 			{
	// 				Name: to.Ptr("DeviceFloor"),
	// 				Type: to.Ptr(armtimeseriesinsights.ReferenceDataKeyPropertyTypeDouble),
	// 		}},
	// 		CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-04-18T19:20:33.228Z"); return t}()),
	// 		ProvisioningState: to.Ptr(armtimeseriesinsights.ProvisioningStateSucceeded),
	// 	},
	// }
}

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.TimeSeriesInsights/Environments/env1/referenceDataSets/rds1",
  "location": "West US",
  "name": "rds1",
  "type": "Microsoft.TimeSeriesInsights/Environments/ReferenceDataSets",
  "tags": {},
  "properties": {
    "keyProperties": [
      {
        "name": "DeviceId1",
        "type": "String"
      },
      {
        "name": "DeviceFloor",
        "type": "Double"
      }
    ],
    "provisioningState": "Succeeded",
    "creationTime": "2017-04-18T19:20:33.2288820Z"
  }
}

Status code:: 201

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/referenceDataSets/rds1",
  "location": "West US",
  "name": "rds1",
  "type": "Microsoft.TimeSeriesInsights/Environments/ReferenceDataSets",
  "tags": {},
  "properties": {
    "keyProperties": [
      {
        "name": "DeviceId1",
        "type": "String"
      },
      {
        "name": "DeviceFloor",
        "type": "Double"
      }
    ],
    "provisioningState": "Succeeded",
    "creationTime": "2017-04-18T19:20:33.2288820Z"
  }
}

Definice

Name	Description
CloudError	Obsahuje informace o chybě rozhraní API.
CloudErrorBody	Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.
DataStringComparisonBehavior	Chování porovnání klíče referenční sady dat lze nastavit pomocí této vlastnosti. Ve výchozím nastavení je hodnota "Pořadové číslo", což znamená, že při spojování referenčních dat s událostmi nebo při přidávání nových referenčních dat se provede porovnání klíčů rozlišujících malá a velká písmena. Při nastavení ordinalIgnoreCase se použije porovnání nerozlišující malá a velká písmena.
ProvisioningState	Stav zřizování prostředku.
ReferenceDataKeyPropertyType	Typ vlastnosti klíče.
ReferenceDataSetCreateOrUpdateParameters
ReferenceDataSetKeyProperty	Vlastnost klíče pro referenční sadu dat. Referenční datová sada může mít několik klíčových vlastností.
ReferenceDataSetResource	Referenční datová sada poskytuje metadata o událostech v prostředí. Metadata v referenční sadě dat se spojí s událostmi, které se čtou ze zdrojů událostí. Metadata, která tvoří sadu referenčních dat, se nahrávají nebo upravují prostřednictvím rozhraní API roviny dat Time Series Insights.

CloudError

Obsahuje informace o chybě rozhraní API.

Name	Typ	Description
error	CloudErrorBody	Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.

CloudErrorBody

Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.

Name	Typ	Description
code	string	Kód chyby, který popisuje chybovou podmínku přesněji než stavový kód HTTP. Dá se použít ke zpracování konkrétních případů chyb prostřednictvím kódu programu.
details	CloudErrorBody[]	Obsahuje vnořené chyby, které s touto chybou souvisejí.
message	string	Zpráva, která podrobně popisuje chybu a poskytuje informace o ladění.
target	string	Cíl konkrétní chyby (například název vlastnosti v chybě).

DataStringComparisonBehavior

Chování porovnání klíče referenční sady dat lze nastavit pomocí této vlastnosti. Ve výchozím nastavení je hodnota "Pořadové číslo", což znamená, že při spojování referenčních dat s událostmi nebo při přidávání nových referenčních dat se provede porovnání klíčů rozlišujících malá a velká písmena. Při nastavení ordinalIgnoreCase se použije porovnání nerozlišující malá a velká písmena.

Name	Typ	Description
Ordinal	string
OrdinalIgnoreCase	string

ProvisioningState

Stav zřizování prostředku.

Name	Typ	Description
Accepted	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

ReferenceDataKeyPropertyType

Typ vlastnosti klíče.

Name	Typ	Description
Bool	string
DateTime	string
Double	string
String	string

ReferenceDataSetCreateOrUpdateParameters

Name	Typ	Description
location	string	Umístění prostředku.
properties.dataStringComparisonBehavior	DataStringComparisonBehavior	Chování porovnání klíče referenční sady dat lze nastavit pomocí této vlastnosti. Ve výchozím nastavení je hodnota "Pořadové číslo", což znamená, že při spojování referenčních dat s událostmi nebo při přidávání nových referenčních dat se provede porovnání klíčů rozlišujících malá a velká písmena. Při nastavení ordinalIgnoreCase se použije porovnání nerozlišující malá a velká písmena.
properties.keyProperties	ReferenceDataSetKeyProperty[]	Seznam klíčových vlastností referenční sady dat.
tags	object	Páry klíč-hodnota dalších vlastností prostředku.

ReferenceDataSetKeyProperty

Vlastnost klíče pro referenční sadu dat. Referenční datová sada může mít několik klíčových vlastností.

Name	Typ	Description
name	string	Název vlastnosti klíče.
type	ReferenceDataKeyPropertyType	Typ vlastnosti klíče.

ReferenceDataSetResource

Referenční datová sada poskytuje metadata o událostech v prostředí. Metadata v referenční sadě dat se spojí s událostmi, které se čtou ze zdrojů událostí. Metadata, která tvoří sadu referenčních dat, se nahrávají nebo upravují prostřednictvím rozhraní API roviny dat Time Series Insights.

Name	Typ	Description
id	string	ID prostředku
location	string	Umístění prostředku
name	string	Název prostředku
properties.creationTime	string	Čas vytvoření prostředku.
properties.dataStringComparisonBehavior	DataStringComparisonBehavior	Chování porovnání klíče referenční sady dat lze nastavit pomocí této vlastnosti. Ve výchozím nastavení je hodnota "Pořadové číslo", což znamená, že při spojování referenčních dat s událostmi nebo při přidávání nových referenčních dat se provede porovnání klíčů rozlišujících malá a velká písmena. Při nastavení ordinalIgnoreCase se použije porovnání nerozlišující malá a velká písmena.
properties.keyProperties	ReferenceDataSetKeyProperty[]	Seznam klíčových vlastností referenční sady dat.
properties.provisioningState	ProvisioningState	Stav zřizování prostředku.
tags	object	Značky prostředků
type	string	Typ prostředku