Reference Data Sets - Create Or Update

Referencia

Service:: Time Series Insights

API Version:: 2020-05-15

Referenciaadat-készlet létrehozása vagy frissítése a megadott környezetben.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
environmentName	path	True	string	A megadott erőforráscsoporthoz társított Time Series Insights-környezet neve.
referenceDataSetName	path	True	string	A referenciaadat-készlet neve. Regex pattern: `^[A-Za-z0-9]`
resourceGroupName	path	True	string	Egy Azure-erőforráscsoport neve.
subscriptionId	path	True	string	Azure-előfizetés azonosítója.
api-version	query	True	string	Az ügyfélkéréshez használandó API verziója.

Kérelem törzse

Name	Kötelező	Típus	Description
location	True	string	Az erőforrás helye.
properties.keyProperties	True	ReferenceDataSetKeyProperty[]	A referenciaadat-készlet kulcstulajdonságainak listája.
properties.dataStringComparisonBehavior		DataStringComparisonBehavior	A referenciaadatkészlet kulcs-összehasonlítási viselkedése ezzel a tulajdonságtal állítható be. Alapértelmezés szerint az érték "Sorszám", ami azt jelenti, hogy a rendszer a hivatkozási adatok eseményekhez való csatlakoztatása vagy új referenciaadatok hozzáadása során a kis- és nagybetűk megkülönböztetésével kapcsolatos összehasonlítást hajtja végre. Ha az "OrdinalIgnoreCase" beállítás be van állítva, a rendszer nem különbözteti meg a kis- és nagybetűket.
tags		object	Az erőforrás további tulajdonságainak kulcs-érték párjai.

Válaszok

Name	Típus	Description
200 OK	ReferenceDataSetResource	A meglévő referenciaadatkészlet-definíció frissítése sikerült.
201 Created	ReferenceDataSetResource	A referenciaadat-készlet létrehozása sikerült.
Other Status Codes	CloudError	HTTP 400 (hibás kérés): A megadott referenciaadatkészlet-kérelemtörzs érvénytelen; A részletekért tekintse meg a hibakódot és az üzenetet a válaszban.

Biztonság

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	felhasználói fiók megszemélyesítése

Példák

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"
  }
}

Definíciók

Name	Description
CloudError	Egy API-hibával kapcsolatos információkat tartalmaz.
CloudErrorBody	Egy adott API-hibát ismertet hibakóddal és üzenettel.
DataStringComparisonBehavior	A referenciaadatkészlet kulcs-összehasonlítási viselkedése ezzel a tulajdonságtal állítható be. Alapértelmezés szerint az érték "Sorszám", ami azt jelenti, hogy a rendszer a hivatkozási adatok eseményekhez való csatlakoztatása vagy új referenciaadatok hozzáadása során a kis- és nagybetűk megkülönböztetésével kapcsolatos összehasonlítást hajtja végre. Ha az "OrdinalIgnoreCase" beállítás be van állítva, a rendszer nem különbözteti meg a kis- és nagybetűket.
ProvisioningState	Az erőforrás kiépítési állapota.
ReferenceDataKeyPropertyType	A kulcstulajdonság típusa.
ReferenceDataSetCreateOrUpdateParameters
ReferenceDataSetKeyProperty	A referenciaadat-készlet kulcstulajdonság. A referenciaadatkészletek több kulcstulajdonságsal is rendelkezhetnek.
ReferenceDataSetResource	A referenciaadat-készlet metaadatokat biztosít a környezet eseményeiről. A referenciaadat-készlet metaadatai eseményekkel lesznek összekapcsolva, amint azokat az eseményforrásokból olvassák. A referenciaadatkészletet alkotó metaadatok feltöltése vagy módosítása a Time Series Insights adatsík API-kkal történik.

CloudError

Egy API-hibával kapcsolatos információkat tartalmaz.

Name	Típus	Description
error	CloudErrorBody	Egy adott API-hibát ismertet hibakóddal és üzenettel.

CloudErrorBody

Egy adott API-hibát ismertet hibakóddal és üzenettel.

Name	Típus	Description
code	string	Egy hibakód, amely pontosabban írja le a hibaállapotot, mint egy HTTP-állapotkód. Adott hibaeseteket programozott módon lehet kezelni.
details	CloudErrorBody[]	Beágyazott hibákat tartalmaz, amelyek ehhez a hibához kapcsolódnak.
message	string	Egy üzenet, amely részletesen leírja a hibát, és hibakeresési információkat tartalmaz.
target	string	Az adott hiba célja (például a hibás tulajdonság neve).

DataStringComparisonBehavior

A referenciaadatkészlet kulcs-összehasonlítási viselkedése ezzel a tulajdonságtal állítható be. Alapértelmezés szerint az érték "Sorszám", ami azt jelenti, hogy a rendszer a hivatkozási adatok eseményekhez való csatlakoztatása vagy új referenciaadatok hozzáadása során a kis- és nagybetűk megkülönböztetésével kapcsolatos összehasonlítást hajtja végre. Ha az "OrdinalIgnoreCase" beállítás be van állítva, a rendszer nem különbözteti meg a kis- és nagybetűket.

Name	Típus	Description
Ordinal	string
OrdinalIgnoreCase	string

ProvisioningState

Az erőforrás kiépítési állapota.

Name	Típus	Description
Accepted	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

ReferenceDataKeyPropertyType

A kulcstulajdonság típusa.

Name	Típus	Description
Bool	string
DateTime	string
Double	string
String	string

ReferenceDataSetCreateOrUpdateParameters

Name	Típus	Description
location	string	Az erőforrás helye.
properties.dataStringComparisonBehavior	DataStringComparisonBehavior	A referenciaadatkészlet kulcs-összehasonlítási viselkedése ezzel a tulajdonságtal állítható be. Alapértelmezés szerint az érték "Sorszám", ami azt jelenti, hogy a rendszer a hivatkozási adatok eseményekhez való csatlakoztatása vagy új referenciaadatok hozzáadása során a kis- és nagybetűk megkülönböztetésével kapcsolatos összehasonlítást hajtja végre. Ha az "OrdinalIgnoreCase" beállítás be van állítva, a rendszer nem különbözteti meg a kis- és nagybetűket.
properties.keyProperties	ReferenceDataSetKeyProperty[]	A referenciaadat-készlet kulcstulajdonságainak listája.
tags	object	Az erőforrás további tulajdonságainak kulcs-érték párjai.

ReferenceDataSetKeyProperty

A referenciaadat-készlet kulcstulajdonság. A referenciaadatkészletek több kulcstulajdonságsal is rendelkezhetnek.

Name	Típus	Description
name	string	A kulcstulajdonság neve.
type	ReferenceDataKeyPropertyType	A kulcstulajdonság típusa.

ReferenceDataSetResource

A referenciaadat-készlet metaadatokat biztosít a környezet eseményeiről. A referenciaadat-készlet metaadatai eseményekkel lesznek összekapcsolva, amint azokat az eseményforrásokból olvassák. A referenciaadatkészletet alkotó metaadatok feltöltése vagy módosítása a Time Series Insights adatsík API-kkal történik.

Name	Típus	Description
id	string	Erőforrás-azonosító
location	string	Erőforrás helye
name	string	Erőforrás neve
properties.creationTime	string	Az erőforrás létrehozásának időpontja.
properties.dataStringComparisonBehavior	DataStringComparisonBehavior	A referenciaadatkészlet kulcs-összehasonlítási viselkedése ezzel a tulajdonságtal állítható be. Alapértelmezés szerint az érték "Sorszám", ami azt jelenti, hogy a rendszer a hivatkozási adatok eseményekhez való csatlakoztatása vagy új referenciaadatok hozzáadása során a kis- és nagybetűk megkülönböztetésével kapcsolatos összehasonlítást hajtja végre. Ha az "OrdinalIgnoreCase" beállítás be van állítva, a rendszer nem különbözteti meg a kis- és nagybetűket.
properties.keyProperties	ReferenceDataSetKeyProperty[]	A referenciaadat-készlet kulcstulajdonságainak listája.
properties.provisioningState	ProvisioningState	Az erőforrás kiépítési állapota.
tags	object	Erőforráscímkék
type	string	Erőforrás típusa