Reference Data Sets - Get

Referencia

Servicio:: Time Series Insights

Versión de la API:: 2020-05-15

Obtiene el conjunto de datos de referencia con el nombre especificado en el entorno especificado.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
environmentName	path	True	string	Nombre del entorno de Time Series Insights asociado al grupo de recursos especificado.
referenceDataSetName	path	True	string	Nombre del conjunto de datos de referencia de Time Series Insights asociado al entorno especificado.
resourceGroupName	path	True	string	Nombre de un grupo de recursos de Azure.
subscriptionId	path	True	string	Identificador de suscripción de Azure.
api-version	query	True	string	Versión de la API que se va a usar con la solicitud de cliente.

Respuestas

Nombre	Tipo	Description
200 OK	ReferenceDataSetResource	La definición del conjunto de datos de referencia se recuperó correctamente y se encuentra en la respuesta.
Other Status Codes	CloudError	HTTP 404 (no encontrado): no se encontró la suscripción, el grupo de recursos, el entorno o el conjunto de datos de referencia.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

ReferenceDataSetsGet

Solicitud de ejemplo

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


/**
 * Samples for ReferenceDataSets Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/
     * ReferenceDataSetsGet.json
     */
    /**
     * Sample code: ReferenceDataSetsGet.
     * 
     * @param manager Entry point to TimeSeriesInsightsManager.
     */
    public static void
        referenceDataSetsGet(com.azure.resourcemanager.timeseriesinsights.TimeSeriesInsightsManager manager) {
        manager.referenceDataSets().getWithResponse("rg1", "env1", "rds1", 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

package armtimeseriesinsights_test

import (
	"context"
	"log"

	"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/ReferenceDataSetsGet.json
func ExampleReferenceDataSetsClient_Get() {
	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().Get(ctx, "rg1", "env1", "rds1", 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

Respuesta de muestra

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

Definiciones

Nombre	Description
CloudError	Contiene información sobre un error de API.
CloudErrorBody	Describe un error de API determinado con un código de error y un mensaje.
DataStringComparisonBehavior	El comportamiento de comparación de claves del conjunto de datos de referencia se puede establecer mediante esta propiedad. De forma predeterminada, el valor es "Ordinal", lo que significa que la comparación de claves confidenciales entre mayúsculas y minúsculas se realizará al combinar datos de referencia con eventos o al agregar nuevos datos de referencia. Cuando se establece 'OrdinalIgnoreCase', se usará la comparación sin distinción entre mayúsculas y minúsculas.
ProvisioningState	Estado de aprovisionamiento del recurso.
ReferenceDataKeyPropertyType	Tipo de la propiedad de clave.
ReferenceDataSetKeyProperty	Propiedad de clave para el conjunto de datos de referencia. Un conjunto de datos de referencia puede tener varias propiedades clave.
ReferenceDataSetResource	Un conjunto de datos de referencia proporciona metadatos sobre los eventos de un entorno. Los metadatos del conjunto de datos de referencia se combinarán con eventos a medida que se leen desde orígenes de eventos. Los metadatos que componen el conjunto de datos de referencia se cargan o modifican a través de las API del plano de datos de Time Series Insights.

CloudError

Object

Contiene información sobre un error de API.

Nombre	Tipo	Description
error	CloudErrorBody	Describe un error de API determinado con un código de error y un mensaje.

CloudErrorBody

Object

Describe un error de API determinado con un código de error y un mensaje.

Nombre	Tipo	Description
code	string	Código de error que describe la condición de error más precisamente que un código de estado HTTP. Se puede usar para controlar mediante programación casos de error específicos.
details	CloudErrorBody[]	Contiene errores anidados relacionados con este error.
message	string	Mensaje que describe el error con detalle y proporciona información de depuración.
target	string	Destino del error concreto (por ejemplo, el nombre de la propiedad en error).

DataStringComparisonBehavior

Enumeración

El comportamiento de comparación de claves del conjunto de datos de referencia se puede establecer mediante esta propiedad. De forma predeterminada, el valor es "Ordinal", lo que significa que la comparación de claves confidenciales entre mayúsculas y minúsculas se realizará al combinar datos de referencia con eventos o al agregar nuevos datos de referencia. Cuando se establece 'OrdinalIgnoreCase', se usará la comparación sin distinción entre mayúsculas y minúsculas.

Valor	Description
Ordinal
OrdinalIgnoreCase

ProvisioningState

Enumeración

Estado de aprovisionamiento del recurso.

Valor	Description
Accepted
Creating
Deleting
Failed
Succeeded
Updating

ReferenceDataKeyPropertyType

Enumeración

Tipo de la propiedad de clave.

Valor	Description
Bool
DateTime
Double
String

ReferenceDataSetKeyProperty

Object

Propiedad de clave para el conjunto de datos de referencia. Un conjunto de datos de referencia puede tener varias propiedades clave.

Nombre	Tipo	Description
name	string	Nombre de la propiedad de clave.
type	ReferenceDataKeyPropertyType	Tipo de la propiedad de clave.

ReferenceDataSetResource

Object

Un conjunto de datos de referencia proporciona metadatos sobre los eventos de un entorno. Los metadatos del conjunto de datos de referencia se combinarán con eventos a medida que se leen desde orígenes de eventos. Los metadatos que componen el conjunto de datos de referencia se cargan o modifican a través de las API del plano de datos de Time Series Insights.

Nombre	Tipo	Description
id	string	Identificador de recurso
location	string	Ubicación del recurso
name	string	Nombre del recurso
properties.creationTime	string (date-time)	Hora en que se creó el recurso.
properties.dataStringComparisonBehavior	DataStringComparisonBehavior	El comportamiento de comparación de claves del conjunto de datos de referencia se puede establecer mediante esta propiedad. De forma predeterminada, el valor es "Ordinal", lo que significa que la comparación de claves confidenciales entre mayúsculas y minúsculas se realizará al combinar datos de referencia con eventos o al agregar nuevos datos de referencia. Cuando se establece 'OrdinalIgnoreCase', se usará la comparación sin distinción entre mayúsculas y minúsculas.
properties.keyProperties	ReferenceDataSetKeyProperty[]	Lista de propiedades clave del conjunto de datos de referencia.
properties.provisioningState	ProvisioningState	Estado de aprovisionamiento del recurso.
tags	object	Etiquetas de recursos
type	string	Tipo de recurso

Compartir a través de

Reference Data Sets - Get

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

ReferenceDataSetsGet

Solicitud de ejemplo

Respuesta de muestra

Definiciones

CloudError

CloudErrorBody

DataStringComparisonBehavior

ProvisioningState

ReferenceDataKeyPropertyType

ReferenceDataSetKeyProperty

ReferenceDataSetResource