你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Reference Data Sets - Create Or Update

参考

Service:: Time Series Insights

API Version:: 2020-05-15

在指定环境中创建或更新引用数据集。

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

URI 参数

名称	在	必需	类型	说明
environmentName	path	True	string	与指定资源组关联的时序见解环境的名称。
referenceDataSetName	path	True	string	引用数据集的名称。 Regex pattern: `^[A-Za-z0-9]`
resourceGroupName	path	True	string	Azure 资源组的名称。
subscriptionId	path	True	string	Azure 订阅 ID。
api-version	query	True	string	要与客户端请求一起使用的 API 的版本。

请求正文

名称	必需	类型	说明
location	True	string	资源的位置。
properties.keyProperties	True	ReferenceDataSetKeyProperty[]	引用数据集的键属性列表。
properties.dataStringComparisonBehavior		DataStringComparisonBehavior	可以使用此属性设置引用数据集键比较行为。默认情况下，该值为“Ordinal”，这意味着在将引用数据与事件联接或添加新引用数据时将执行区分大小写的键比较。设置“OrdinalIgnoreCase”时，将使用不区分大小写的比较。
tags		object	资源的附加属性的键值对。

响应

名称	类型	说明
200 OK	ReferenceDataSetResource	已成功更新现有引用数据集定义。
201 Created	ReferenceDataSetResource	已成功创建引用数据集。
Other Status Codes	CloudError	HTTP 400 (错误的请求) ：给定的引用数据集请求正文无效;有关详细信息，请参阅响应中的错误代码和消息。

安全性

azure_auth

Azure Active Directory OAuth2 流

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

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

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

定义

名称	说明
CloudError	包含有关 API 错误的信息。
CloudErrorBody	使用错误代码和消息描述特定的 API 错误。
DataStringComparisonBehavior	可以使用此属性设置引用数据集键比较行为。默认情况下，该值为“Ordinal”，这意味着在将引用数据与事件联接或添加新引用数据时将执行区分大小写的键比较。设置“OrdinalIgnoreCase”时，将使用不区分大小写的比较。
ProvisioningState	资源的预配状态。
ReferenceDataKeyPropertyType	键属性的类型。
ReferenceDataSetCreateOrUpdateParameters
ReferenceDataSetKeyProperty	引用数据集的键属性。引用数据集可以有多个键属性。
ReferenceDataSetResource	参考数据集提供有关环境中事件的元数据。从事件源读取时，引用数据集中的元数据将与事件联接在一起。构成引用数据集的元数据通过时序见解数据平面 API 上传或修改。

CloudError

包含有关 API 错误的信息。

名称	类型	说明
error	CloudErrorBody	使用错误代码和消息描述特定的 API 错误。

CloudErrorBody

使用错误代码和消息描述特定的 API 错误。

名称	类型	说明
code	string	描述错误条件的错误代码比 HTTP 状态代码更精确。可用于以编程方式处理特定错误情况。
details	CloudErrorBody[]	包含与此错误相关的嵌套错误。
message	string	详细描述错误并提供调试信息的消息。
target	string	特定错误的目标 (例如，错误) 中属性的名称。

DataStringComparisonBehavior

可以使用此属性设置引用数据集键比较行为。默认情况下，该值为“Ordinal”，这意味着在将引用数据与事件联接或添加新引用数据时将执行区分大小写的键比较。设置“OrdinalIgnoreCase”时，将使用不区分大小写的比较。

名称	类型	说明
Ordinal	string
OrdinalIgnoreCase	string

ProvisioningState

资源的预配状态。

名称	类型	说明
Accepted	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

ReferenceDataKeyPropertyType

键属性的类型。

名称	类型	说明
Bool	string
DateTime	string
Double	string
String	string

ReferenceDataSetCreateOrUpdateParameters

名称	类型	说明
location	string	资源的位置。
properties.dataStringComparisonBehavior	DataStringComparisonBehavior	可以使用此属性设置引用数据集键比较行为。默认情况下，该值为“Ordinal”，这意味着在将引用数据与事件联接或添加新引用数据时将执行区分大小写的键比较。设置“OrdinalIgnoreCase”时，将使用不区分大小写的比较。
properties.keyProperties	ReferenceDataSetKeyProperty[]	引用数据集的键属性列表。
tags	object	资源的附加属性的键值对。

ReferenceDataSetKeyProperty

引用数据集的键属性。引用数据集可以有多个键属性。

名称	类型	说明
name	string	键属性的名称。
type	ReferenceDataKeyPropertyType	键属性的类型。

ReferenceDataSetResource

参考数据集提供有关环境中事件的元数据。从事件源读取时，引用数据集中的元数据将与事件联接在一起。构成引用数据集的元数据通过时序见解数据平面 API 上传或修改。

名称	类型	说明
id	string	资源 ID
location	string	资源位置
name	string	资源名称
properties.creationTime	string	创建资源的时间。
properties.dataStringComparisonBehavior	DataStringComparisonBehavior	可以使用此属性设置引用数据集键比较行为。默认情况下，该值为“Ordinal”，这意味着在将引用数据与事件联接或添加新引用数据时将执行区分大小写的键比较。设置“OrdinalIgnoreCase”时，将使用不区分大小写的比较。
properties.keyProperties	ReferenceDataSetKeyProperty[]	引用数据集的键属性列表。
properties.provisioningState	ProvisioningState	资源的预配状态。
tags	object	资源标记
type	string	资源类型