Environments - Get

Başvuru

Service:: Time Series Insights

API Version:: 2020-05-15

Belirtilen abonelikte ve kaynak grubunda belirtilen ada sahip ortamı alır.

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

With optional parameters:

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
environmentName	path	True	string	Belirtilen kaynak grubuyla ilişkili Time Series Insights ortamının adı.
resourceGroupName	path	True	string	Azure Kaynak grubunun adı.
subscriptionId	path	True	string	Azure Abonelik Kimliği.
api-version	query	True	string	İstemci isteğiyle kullanılacak API'nin sürümü.
$expand	query		string	$expand=status ayarı, Time Series Insights hizmetindeki ortamın iç hizmetlerinin durumunu içerir.

Yanıtlar

Name	Tür	Description
200 OK	EnvironmentResource: Gen1EnvironmentResource Gen2EnvironmentResource	Ortam tanımı başarıyla alındı ve yanıtta. Sağlama veya ölçeklendirme işleminin tamamlanmasını yoklarsanız, provisioningState özelliği aracılığıyla durumunu de kontrol edebilirsiniz.
Other Status Codes	CloudError	HTTP 404 (Bulunamadı): Abonelik, kaynak grubu veya ortam bulunamadı.

Güvenlik

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	kullanıcı hesabınızın kimliğine bürünme

Örnekler

EnvironmentsGet

Sample Request

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

/** Samples for Environments GetByResourceGroup. */
public final class Main {
    /*
     * x-ms-original-file: specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EnvironmentsGet.json
     */
    /**
     * Sample code: EnvironmentsGet.
     *
     * @param manager Entry point to TimeSeriesInsightsManager.
     */
    public static void environmentsGet(com.azure.resourcemanager.timeseriesinsights.TimeSeriesInsightsManager manager) {
        manager.environments().getByResourceGroupWithResponse("rg1", "env1", null, 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/EnvironmentsGet.json
func ExampleEnvironmentsClient_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.NewEnvironmentsClient().Get(ctx, "rg1", "env1", &armtimeseriesinsights.EnvironmentsClientGetOptions{Expand: 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 = armtimeseriesinsights.EnvironmentsClientGetResponse{
	// 	                            EnvironmentResourceClassification: &armtimeseriesinsights.Gen1EnvironmentResource{
	// 		Name: to.Ptr("env1"),
	// 		Type: to.Ptr("Microsoft.TimeSeriesInsights/Environments"),
	// 		ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1"),
	// 		Location: to.Ptr("West US"),
	// 		Tags: map[string]*string{
	// 		},
	// 		Kind: to.Ptr(armtimeseriesinsights.EnvironmentResourceKindGen1),
	// 		SKU: &armtimeseriesinsights.SKU{
	// 			Name: to.Ptr(armtimeseriesinsights.SKUNameS1),
	// 			Capacity: to.Ptr[int32](1),
	// 		},
	// 		Properties: &armtimeseriesinsights.Gen1EnvironmentResourceProperties{
	// 			CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-04-18T19:20:33.228Z"); return t}()),
	// 			ProvisioningState: to.Ptr(armtimeseriesinsights.ProvisioningStateSucceeded),
	// 			DataRetentionTime: to.Ptr("P31D"),
	// 			PartitionKeyProperties: []*armtimeseriesinsights.TimeSeriesIDProperty{
	// 				{
	// 					Name: to.Ptr("DeviceId1"),
	// 					Type: to.Ptr(armtimeseriesinsights.PropertyTypeString),
	// 			}},
	// 		},
	// 	},
	// 	                        }
}

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",
  "location": "West US",
  "name": "env1",
  "type": "Microsoft.TimeSeriesInsights/Environments",
  "kind": "Gen1",
  "tags": {},
  "properties": {
    "dataRetentionTime": "P31D",
    "provisioningState": "Succeeded",
    "creationTime": "2017-04-18T19:20:33.2288820Z",
    "partitionKeyProperties": [
      {
        "name": "DeviceId1",
        "type": "String"
      }
    ]
  },
  "sku": {
    "name": "S1",
    "capacity": 1
  }
}

Tanımlar

Name	Description
CloudError	API hatası hakkında bilgi içerir.
CloudErrorBody	Hata kodu ve ileti içeren belirli bir API hatası açıklanır.
EnvironmentStateDetails	Bir ortamın durumuyla ilgili ayrıntıları içeren nesne.
EnvironmentStatus	Ortamın durumunu ve Time Series Insights hizmetindeki iç durumunu temsil eden bir nesne.
Gen1EnvironmentResource	Ortam, sorgu için kullanılabilen bir zaman serisi verileri kümesidir ve kaynak Azure Time Series Insights en üst düzeydir. 1. Nesil ortamlarının veri saklama sınırları vardır.
Gen2EnvironmentResource	Ortam, sorgu için kullanılabilen bir zaman serisi verileri kümesidir ve kaynak Azure Time Series Insights en üst düzeydir. 2. Nesil ortamlarında veri saklama sınırları ayarlanmaz.
Gen2StorageConfigurationOutput	Depolama yapılandırması, ortamın verilerini depolamak için kullanılan müşteri depolama hesabıyla ilgili gizli olmayan bağlantı ayrıntılarını sağlar.
IngressEnvironmentStatus	Bir ortamda girişin durumunu temsil eden nesne.
IngressState	Bu dize, bir ortamdaki giriş işlemlerinin durumunu temsil eder. "Devre Dışı", "Hazır", "Çalışıyor", "Duraklatıldı" veya "Bilinmiyor" olabilir
PropertyType	Özelliğin türü.
ProvisioningState	Kaynağın sağlama durumu.
Sku	Sku, ortam türünü (1. Nesil (S1 veya S2) veya 2. Nesil (L1) belirler. 1. Nesil ortamlarında sku ortamın kapasitesini, giriş oranını ve faturalama oranını belirler.
SkuName	Bu SKU'nun adı.
StorageLimitExceededBehavior	Ortamın kapasitesi aşıldığında Time Series Insights hizmetinin alması gereken davranış. "PauseIngress" belirtilirse, olay kaynağından yeni olaylar okunmayacak. "PurgeOldData" belirtilirse, yeni olaylar okunmaya devam eder ve eski olaylar ortamdan silinir. Varsayılan davranış PurgeOldData'dır.
TimeSeriesIdProperty	Bir zaman serisi kimliğinin sahip olabileceği özelliğin yapısı. Bir ortam, bu tür birden çok özelliğe sahip olabilir.
WarmStorageEnvironmentStatus	Bir ortamdaki sıcak depolama durumunu temsil eden nesne.
WarmStoragePropertiesState	Bu dize, sıcak depolama özellikleri kullanımının durumunu temsil eder. "Tamam", "Hata", "Bilinmiyor" olabilir.
WarmStoreConfigurationProperties	Sıcak depo yapılandırması, ortamın daha hızlı sorgulanabilen verilerinin bir kopyasını saklayacak bir sıcak depo önbelleği oluşturma ayrıntılarını sağlar.

CloudError

API hatası hakkında bilgi içerir.

Name	Tür	Description
error	CloudErrorBody	Hata kodu ve ileti içeren belirli bir API hatası açıklanır.

CloudErrorBody

Hata kodu ve ileti içeren belirli bir API hatası açıklanır.

Name	Tür	Description
code	string	Http durum kodundan daha kesin bir şekilde hata koşulunu açıklayan bir hata kodu. Belirli hata durumlarını program aracılığıyla işlemek için kullanılabilir.
details	CloudErrorBody[]	Bu hatayla ilgili iç içe hatalar içerir.
message	string	Hatayı ayrıntılı olarak açıklayan ve hata ayıklama bilgileri sağlayan bir ileti.
target	string	Belirli bir hatanın hedefi (örneğin, hatadaki özelliğin adı).

EnvironmentStateDetails

Bir ortamın durumuyla ilgili ayrıntıları içeren nesne.

Name	Tür	Description
code	string	Bir ortamın belirli bir durumda olmasının nedenini temsil eden kodu içerir. Belirli servis taleplerini program aracılığıyla işlemek için kullanılabilir.
message	string	Durumu ayrıntılı olarak açıklayan bir ileti.

EnvironmentStatus

Ortamın durumunu ve Time Series Insights hizmetindeki iç durumunu temsil eden bir nesne.

Name	Tür	Description
ingress	IngressEnvironmentStatus	Bir ortamda girişin durumunu temsil eden nesne.
warmStorage	WarmStorageEnvironmentStatus	Bir ortamdaki sıcak depolama durumunu temsil eden nesne.

Gen1EnvironmentResource

Ortam, sorgu için kullanılabilen bir zaman serisi verileri kümesidir ve kaynak Azure Time Series Insights en üst düzeydir. 1. Nesil ortamlarının veri saklama sınırları vardır.

Name	Tür	Description
creationTime	string	Kaynağın oluşturulduğu saat.
id	string	Kaynak Kimliği
kind	string: Gen1	Ortamın türü.
location	string	Kaynak konumu
name	string	Kaynak adı
properties.dataAccessFqdn	string	Ortam verilerine erişmek için kullanılan tam etki alanı adı; örneğin, ortamın olaylarını sorgulamak veya ortam için başvuru verilerini karşıya yüklemek.
properties.dataAccessId	string	Ortam verilerine erişmek için kullanılan kimlik; örneğin, ortamın olaylarını sorgulamak veya ortam için başvuru verilerini karşıya yüklemek.
properties.dataRetentionTime	string	ISO8601 zaman aralığı, ortam olaylarının sorgu için en az kaç gün kullanılabilir olacağını belirtir.
properties.partitionKeyProperties	TimeSeriesIdProperty[]	Ortamdaki verileri bölümlendirmek için kullanılacak olay özelliklerinin listesi. Şu anda yalnızca tek bir bölüm anahtarı özelliği desteklenmektedir.
properties.status	EnvironmentStatus	Ortamın durumunu ve Time Series Insights hizmetindeki iç durumunu temsil eden bir nesne.
properties.storageLimitExceededBehavior	StorageLimitExceededBehavior	Ortamın kapasitesi aşıldığında Time Series Insights hizmetinin alması gereken davranış. "PauseIngress" belirtilirse, olay kaynağından yeni olaylar okunmayacak. "PurgeOldData" belirtilirse, yeni olaylar okunmaya devam eder ve eski olaylar ortamdan silinir. Varsayılan davranış PurgeOldData'dır.
provisioningState	ProvisioningState	Kaynağın sağlama durumu.
sku	Sku	Sku, ortam türünü (1. Nesil (S1 veya S2) veya 2. Nesil (L1) belirler. 1. Nesil ortamlarında sku ortamın kapasitesini, giriş oranını ve faturalama oranını belirler.
tags	object	Kaynak etiketleri
type	string	Kaynak türü

Gen2EnvironmentResource

Ortam, sorgu için kullanılabilen bir zaman serisi verileri kümesidir ve kaynak Azure Time Series Insights en üst düzeydir. 2. Nesil ortamlarında veri saklama sınırları ayarlanmaz.

Name	Tür	Description
creationTime	string	Kaynağın oluşturulduğu saat.
id	string	Kaynak Kimliği
kind	string: Gen2	Ortamın türü.
location	string	Kaynak konumu
name	string	Kaynak adı
properties.dataAccessFqdn	string	Ortam verilerine erişmek için kullanılan tam etki alanı adı; örneğin, ortamın olaylarını sorgulamak veya ortam için başvuru verilerini karşıya yüklemek.
properties.dataAccessId	string	Ortam verilerine erişmek için kullanılan kimlik; örneğin, ortamın olaylarını sorgulamak veya ortam için başvuru verilerini karşıya yüklemek.
properties.status	EnvironmentStatus	Ortamın durumunu ve Time Series Insights hizmetindeki iç durumunu temsil eden bir nesne.
properties.storageConfiguration	Gen2StorageConfigurationOutput	Depolama yapılandırması, Time Series Insights hizmetinin ortamın verilerini depolamak için kullanılan müşteri depolama hesabına bağlanmasını sağlayan bağlantı ayrıntılarını sağlar.
properties.timeSeriesIdProperties	TimeSeriesIdProperty[]	Ortamın zaman serisi kimliğini tanımlamak için kullanılacak olay özelliklerinin listesi.
properties.warmStoreConfiguration	WarmStoreConfigurationProperties	Sıcak depo yapılandırması, ortamın daha hızlı sorgulanabilen verilerinin bir kopyasını saklayacak bir sıcak depo önbelleği oluşturma ayrıntılarını sağlar.
provisioningState	ProvisioningState	Kaynağın sağlama durumu.
sku	Sku	Sku, ortam türünü (1. Nesil (S1 veya S2) veya 2. Nesil (L1) belirler. 1. Nesil ortamlarında sku ortamın kapasitesini, giriş oranını ve faturalama oranını belirler.
tags	object	Kaynak etiketleri
type	string	Kaynak türü

Gen2StorageConfigurationOutput

Depolama yapılandırması, ortamın verilerini depolamak için kullanılan müşteri depolama hesabıyla ilgili gizli olmayan bağlantı ayrıntılarını sağlar.

Name	Tür	Description
accountName	string	Ortamın 2. Nesil verilerini barındıracak depolama hesabının adı.

IngressEnvironmentStatus

Bir ortamda girişin durumunu temsil eden nesne.

Name	Tür	Description
state	IngressState	Bu dize, bir ortamdaki giriş işlemlerinin durumunu temsil eder. "Devre Dışı", "Hazır", "Çalışıyor", "Duraklatıldı" veya "Bilinmiyor" olabilir
stateDetails	EnvironmentStateDetails	Bir ortamın durumuyla ilgili ayrıntıları içeren nesne.

IngressState

Bu dize, bir ortamdaki giriş işlemlerinin durumunu temsil eder. "Devre Dışı", "Hazır", "Çalışıyor", "Duraklatıldı" veya "Bilinmiyor" olabilir

Name	Tür	Description
Disabled	string
Paused	string
Ready	string
Running	string
Unknown	string

PropertyType

Özelliğin türü.

Name	Tür	Description
String	string

ProvisioningState

Kaynağın sağlama durumu.

Name	Tür	Description
Accepted	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

Sku

Sku, ortam türünü (1. Nesil (S1 veya S2) veya 2. Nesil (L1) belirler. 1. Nesil ortamlarında sku ortamın kapasitesini, giriş oranını ve faturalama oranını belirler.

Name	Tür	Description
capacity	integer	Sku'nun kapasitesi. 1. Nesil ortamlarında, bu değer oluşturulduktan sonra ortamların ölçeğini genişletmeyi destekleyecek şekilde değiştirilebilir.
name	SkuName	Bu SKU'nun adı.

SkuName

Bu SKU'nun adı.

Name	Tür	Description
L1	string
P1	string
S1	string
S2	string

StorageLimitExceededBehavior

Ortamın kapasitesi aşıldığında Time Series Insights hizmetinin alması gereken davranış. "PauseIngress" belirtilirse, olay kaynağından yeni olaylar okunmayacak. "PurgeOldData" belirtilirse, yeni olaylar okunmaya devam eder ve eski olaylar ortamdan silinir. Varsayılan davranış PurgeOldData'dır.

Name	Tür	Description
PauseIngress	string
PurgeOldData	string

TimeSeriesIdProperty

Bir zaman serisi kimliğinin sahip olabileceği özelliğin yapısı. Bir ortam, bu tür birden çok özelliğe sahip olabilir.

Name	Tür	Description
name	string	Özelliğin adı.
type	PropertyType	Özelliğin türü.

WarmStorageEnvironmentStatus

Bir ortamdaki sıcak depolama durumunu temsil eden nesne.

Name	Tür	Description
propertiesUsage.state	WarmStoragePropertiesState	Bu dize, sıcak depolama özellikleri kullanımının durumunu temsil eder. "Tamam", "Hata", "Bilinmiyor" olabilir.
propertiesUsage.stateDetails.currentCount	integer	S1/S2 SKU için ortam tarafından kullanılan özelliklerin sayısını ve PAYG SKU'su için Warm Store tarafından kullanılan özelliklerin sayısını gösteren değer
propertiesUsage.stateDetails.maxCount	integer	Ortam tarafından S1/S2 SKU için izin verilen en fazla özellik sayısını ve PAYG SKU'su için Warm Store tarafından izin verilen maksimum özellik sayısını temsil eden bir değer.

WarmStoragePropertiesState

Bu dize, sıcak depolama özellikleri kullanımının durumunu temsil eder. "Tamam", "Hata", "Bilinmiyor" olabilir.

Name	Tür	Description
Error	string
Ok	string
Unknown	string

WarmStoreConfigurationProperties

Sıcak depo yapılandırması, ortamın daha hızlı sorgulanabilen verilerinin bir kopyasını saklayacak bir sıcak depo önbelleği oluşturma ayrıntılarını sağlar.

Name	Tür	Description
dataRetention	string	ortam olaylarının sıcak depodan sorgu için kaç gün süreyle kullanılabilir olacağını belirten ISO8601 zaman aralığı.