Environments - Create Or Update

在指定的訂用帳戶和資源群組中建立或更新環境。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}?api-version=2018-08-15-preview

URI 參數

Name In Required Type Description
environmentName
path True
  • string

環境的名稱

Regex pattern: ^[-\w\._\(\)]+$

resourceGroupName
path True
  • string

Azure 資源群組的名稱。

subscriptionId
path True
  • string

Azure 訂用帳戶識別碼。

api-version
query True
  • string

要搭配用戶端要求使用的 API 版本。

要求本文

要求主體可以是下列其中一項:

Name Description
LongTermEnvironmentCreateOrUpdateParameters

針對長期環境提供給建立或更新環境作業的參數。

StandardEnvironmentCreateOrUpdateParameters

提供給標準環境之建立或更新環境作業的參數。

LongTermEnvironmentCreateOrUpdateParameters

針對長期環境提供給建立或更新環境作業的參數。

Name Required Type Description
kind True string:
  • LongTerm

環境的種類。

location True
  • string

資源的位置。

properties.storageConfiguration True

儲存體設定提供連線詳細資料,可讓時間序列深入解析服務連接到用來儲存環境資料的客戶儲存體帳戶。

properties.timeSeriesIdProperties True

事件屬性的清單,這些屬性將用來定義環境的時間序列識別碼。

sku True

Sku 會決定環境的類型,標準 (S1 或 S2) 或長期 (L1) 。 針對標準環境,sku 會決定環境的容量、輸入費率和帳單費率。

properties.warmStoreConfiguration

暖存放區設定會提供詳細資料來建立暖存放區快取,以保留環境資料的複本,以加快查詢速度。

tags
  • object

資源之其他屬性的索引鍵/值配對。

StandardEnvironmentCreateOrUpdateParameters

提供給標準環境之建立或更新環境作業的參數。

Name Required Type Description
kind True string:
  • Standard

環境的種類。

location True
  • string

資源的位置。

properties.dataRetentionTime True
  • string

ISO8601 timespan,指定環境的事件將可用於查詢的最少天數。

sku True

Sku 會決定環境的類型,標準 (S1 或 S2) 或長期 (L1) 。 針對標準環境,sku 會決定環境的容量、輸入費率和帳單費率。

properties.partitionKeyProperties

將在環境中用來分割資料的事件屬性清單。 目前只支援單一分割區索引鍵屬性。

properties.storageLimitExceededBehavior

當超過環境的容量時,時間序列深入解析服務應採取的行為。 如果指定 "PauseIngress",將不會從事件來源讀取新的事件。 如果指定了 "PurgeOldData",將會繼續讀取新的事件,並從環境中刪除舊的事件。 預設行為是 PurgeOldData。

tags
  • object

資源之其他屬性的索引鍵/值配對。

回應

Name Type Description
200 OK EnvironmentResource:

已成功更新現有的環境定義。

201 Created EnvironmentResource:

已接受環境建立要求。 環境布建是非同步作業。 您可以透過 provisioningState 屬性定期取得環境定義和監視進度。

404 Not Found

找不到訂用帳戶或資源群組。

Other Status Codes

HTTP 400 (錯誤的要求) :指定的環境要求主體無效;如需詳細資料,請參閱回應中的錯誤碼和訊息。

安全性

azure_auth

Azure Active Directory OAuth2 流程

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

Scopes

Name Description
user_impersonation 模擬您的使用者帳戶

範例

EnvironmentsCreate

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/environments/env1?api-version=2018-08-15-preview
{
  "location": "West US",
  "kind": "Standard",
  "sku": {
    "name": "S1",
    "capacity": 1
  },
  "properties": {
    "dataRetentionTime": "P31D",
    "partitionKeyProperties": [
      {
        "name": "DeviceId1",
        "type": "String"
      }
    ]
  }
}

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1",
  "location": "West US",
  "name": "env1",
  "type": "Microsoft.TimeSeriesInsights/Environments",
  "kind": "Standard",
  "tags": {},
  "properties": {
    "dataRetentionTime": "P31D",
    "provisioningState": "Creating",
    "creationTime": "2017-04-18T19:20:33.2288820Z"
  },
  "sku": {
    "name": "S1",
    "capacity": 1
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1",
  "location": "West US",
  "name": "env1",
  "type": "Microsoft.TimeSeriesInsights/Environments",
  "kind": "Standard",
  "tags": {},
  "properties": {
    "dataRetentionTime": "P31D",
    "provisioningState": "Succeeded",
    "creationTime": "2017-04-18T19:20:33.2288820Z"
  },
  "sku": {
    "name": "S1",
    "capacity": 1
  }
}

定義

CloudError

包含 API 錯誤的相關資訊。

CloudErrorBody

描述具有錯誤碼和訊息的特定 API 錯誤。

EnvironmentStateDetails

物件,其中包含環境狀態的詳細資料。

EnvironmentStatus

代表環境狀態的物件,以及其在時間序列深入解析服務中的內部狀態。

IngressEnvironmentStatus

物件,表示環境上輸入的狀態。

IngressState

這個字串代表環境上輸入作業的狀態。 它可以是 [已停用]、[就緒]、[執行中]、[已暫停] 或 [未知]

LongTermEnvironmentCreateOrUpdateParameters

針對長期環境提供給建立或更新環境作業的參數。

LongTermEnvironmentResource

環境是一組可供查詢的時間序列資料,而且是最上層的 Azure 時間序列深入解析資源。 LongTerm 環境沒有設定資料保留限制。

LongTermStorageConfigurationInput

儲存體設定提供連線詳細資料,可讓時間序列深入解析服務連接到用來儲存環境資料的客戶儲存體帳戶。

LongTermStorageConfigurationOutput

儲存體設定提供有關用來儲存環境資料之客戶儲存體帳戶的非秘密連線詳細資料。

PropertyType

屬性的類型。

ProvisioningState

資源的布建狀態。

Sku

Sku 會決定環境的類型,標準 (S1 或 S2) 或長期 (L1) 。 針對標準環境,sku 會決定環境的容量、輸入費率和帳單費率。

SkuName

此 SKU 的名稱。

StandardEnvironmentCreateOrUpdateParameters

提供給標準環境之建立或更新環境作業的參數。

StandardEnvironmentResource

環境是一組可供查詢的時間序列資料,而且是最上層的 Azure 時間序列深入解析資源。 標準環境具有資料保留限制。

StorageLimitExceededBehavior

當超過環境的容量時,時間序列深入解析服務應採取的行為。 如果指定 "PauseIngress",將不會從事件來源讀取新的事件。 如果指定了 "PurgeOldData",將會繼續讀取新的事件,並從環境中刪除舊的事件。 預設行為是 PurgeOldData。

TimeSeriesIdProperty

時間序列識別碼可擁有的屬性結構。 環境可以有多個這類屬性。

WarmStorageEnvironmentStatus

物件,表示環境中暖儲存體的狀態。

WarmStoragePropertiesState

此字串表示暖儲存體屬性使用狀況的狀態。 它可以是「確定」、「錯誤」、「未知」。

WarmStoreConfigurationProperties

暖存放區設定會提供詳細資料來建立暖存放區快取,以保留環境資料的複本,以加快查詢速度。

CloudError

包含 API 錯誤的相關資訊。

Name Type Description
error

描述具有錯誤碼和訊息的特定 API 錯誤。

CloudErrorBody

描述具有錯誤碼和訊息的特定 API 錯誤。

Name Type Description
code
  • string

描述錯誤狀況的錯誤碼,比 HTTP 狀態碼更精確。 可以用來以程式設計方式處理特定的錯誤情況。

details

包含與此錯誤相關的嵌套錯誤。

message
  • string

詳細描述錯誤的訊息,並提供偵錯工具資訊。

target
  • string

特定錯誤的目標 (例如,錯誤) 中屬性的名稱。

EnvironmentStateDetails

物件,其中包含環境狀態的詳細資料。

Name Type Description
code
  • string

包含的程式碼代表環境處於特定狀態的原因。 可以用來以程式設計方式處理特定案例。

message
  • string

詳細描述狀態的訊息。

EnvironmentStatus

代表環境狀態的物件,以及其在時間序列深入解析服務中的內部狀態。

Name Type Description
ingress

物件,表示環境上輸入的狀態。

warmStorage

物件,表示環境中暖儲存體的狀態。

IngressEnvironmentStatus

物件,表示環境上輸入的狀態。

Name Type Description
state

這個字串代表環境上輸入作業的狀態。 它可以是 [已停用]、[就緒]、[執行中]、[已暫停] 或 [未知]

stateDetails

物件,其中包含環境狀態的詳細資料。

IngressState

這個字串代表環境上輸入作業的狀態。 它可以是 [已停用]、[就緒]、[執行中]、[已暫停] 或 [未知]

Name Type Description
Disabled
  • string
Paused
  • string
Ready
  • string
Running
  • string
Unknown
  • string

LongTermEnvironmentCreateOrUpdateParameters

針對長期環境提供給建立或更新環境作業的參數。

Name Type Description
kind string:
  • LongTerm

環境的種類。

location
  • string

資源的位置。

properties.storageConfiguration

儲存體設定提供連線詳細資料,可讓時間序列深入解析服務連接到用來儲存環境資料的客戶儲存體帳戶。

properties.timeSeriesIdProperties

事件屬性的清單,這些屬性將用來定義環境的時間序列識別碼。

properties.warmStoreConfiguration

暖存放區設定會提供詳細資料來建立暖存放區快取,以保留環境資料的複本,以加快查詢速度。

sku

Sku 會決定環境的類型,標準 (S1 或 S2) 或長期 (L1) 。 針對標準環境,sku 會決定環境的容量、輸入費率和帳單費率。

tags
  • object

資源之其他屬性的索引鍵/值配對。

LongTermEnvironmentResource

環境是一組可供查詢的時間序列資料,而且是最上層的 Azure 時間序列深入解析資源。 LongTerm 環境沒有設定資料保留限制。

Name Type Description
creationTime
  • string

建立資源的時間。

id
  • string

資源識別碼

kind string:
  • LongTerm

環境的種類。

location
  • string

資源位置

name
  • string

資源名稱

properties.creationTime
  • string

建立資源的時間。

properties.dataAccessFqdn
  • string

用來存取環境資料的完整功能變數名稱,例如,用來查詢環境的事件或上傳環境的參考資料。

properties.dataAccessId
  • string

用來存取環境資料的識別碼,例如,用來查詢環境的事件或上傳環境的參考資料。

properties.provisioningState

資源的布建狀態。

properties.status

代表環境狀態的物件,以及其在時間序列深入解析服務中的內部狀態。

properties.storageConfiguration

儲存體設定提供連線詳細資料,可讓時間序列深入解析服務連接到用來儲存環境資料的客戶儲存體帳戶。

properties.timeSeriesIdProperties

事件屬性的清單,這些屬性將用來定義環境的時間序列識別碼。

properties.warmStoreConfiguration

暖存放區設定會提供詳細資料來建立暖存放區快取,以保留環境資料的複本,以加快查詢速度。

provisioningState

資源的布建狀態。

sku

Sku 會決定環境的類型,標準 (S1 或 S2) 或長期 (L1) 。 針對標準環境,sku 會決定環境的容量、輸入費率和帳單費率。

tags
  • object

資源標籤

type
  • string

資源類型

LongTermStorageConfigurationInput

儲存體設定提供連線詳細資料,可讓時間序列深入解析服務連接到用來儲存環境資料的客戶儲存體帳戶。

Name Type Description
accountName
  • string

將保存環境長期資料的儲存體帳戶名稱。

managementKey
  • string

管理金鑰的值,可授與時間序列深入解析服務對儲存體帳戶的寫入存取權。 這個屬性不會顯示在環境回應中。

LongTermStorageConfigurationOutput

儲存體設定提供有關用來儲存環境資料之客戶儲存體帳戶的非秘密連線詳細資料。

Name Type Description
accountName
  • string

將保存環境長期資料的儲存體帳戶名稱。

PropertyType

屬性的類型。

Name Type Description
String
  • string

ProvisioningState

資源的布建狀態。

Name Type Description
Accepted
  • string
Creating
  • string
Deleting
  • string
Failed
  • string
Succeeded
  • string
Updating
  • string

Sku

Sku 會決定環境的類型,標準 (S1 或 S2) 或長期 (L1) 。 針對標準環境,sku 會決定環境的容量、輸入費率和帳單費率。

Name Type Description
capacity
  • integer

Sku 的容量。 在標準環境中,您可以變更此值,以在建立環境之後支援相應放大環境。

name

此 SKU 的名稱。

SkuName

此 SKU 的名稱。

Name Type Description
L1
  • string
P1
  • string
S1
  • string
S2
  • string

StandardEnvironmentCreateOrUpdateParameters

提供給標準環境之建立或更新環境作業的參數。

Name Type Description
kind string:
  • Standard

環境的種類。

location
  • string

資源的位置。

properties.dataRetentionTime
  • string

ISO8601 timespan,指定環境的事件將可用於查詢的最少天數。

properties.partitionKeyProperties

將在環境中用來分割資料的事件屬性清單。 目前只支援單一分割區索引鍵屬性。

properties.storageLimitExceededBehavior

當超過環境的容量時,時間序列深入解析服務應採取的行為。 如果指定 "PauseIngress",將不會從事件來源讀取新的事件。 如果指定了 "PurgeOldData",將會繼續讀取新的事件,並從環境中刪除舊的事件。 預設行為是 PurgeOldData。

sku

Sku 會決定環境的類型,標準 (S1 或 S2) 或長期 (L1) 。 針對標準環境,sku 會決定環境的容量、輸入費率和帳單費率。

tags
  • object

資源之其他屬性的索引鍵/值配對。

StandardEnvironmentResource

環境是一組可供查詢的時間序列資料,而且是最上層的 Azure 時間序列深入解析資源。 標準環境具有資料保留限制。

Name Type Description
creationTime
  • string

建立資源的時間。

id
  • string

資源識別碼

kind string:
  • Standard

環境的種類。

location
  • string

資源位置

name
  • string

資源名稱

properties.creationTime
  • string

建立資源的時間。

properties.dataAccessFqdn
  • string

用來存取環境資料的完整功能變數名稱,例如,用來查詢環境的事件或上傳環境的參考資料。

properties.dataAccessId
  • string

用來存取環境資料的識別碼,例如,用來查詢環境的事件或上傳環境的參考資料。

properties.dataRetentionTime
  • string

ISO8601 timespan,指定環境的事件將可用於查詢的最少天數。

properties.partitionKeyProperties

將在環境中用來分割資料的事件屬性清單。 目前只支援單一分割區索引鍵屬性。

properties.provisioningState

資源的布建狀態。

properties.status

代表環境狀態的物件,以及其在時間序列深入解析服務中的內部狀態。

properties.storageLimitExceededBehavior

當超過環境的容量時,時間序列深入解析服務應採取的行為。 如果指定 "PauseIngress",將不會從事件來源讀取新的事件。 如果指定了 "PurgeOldData",將會繼續讀取新的事件,並從環境中刪除舊的事件。 預設行為是 PurgeOldData。

provisioningState

資源的布建狀態。

sku

Sku 會決定環境的類型,標準 (S1 或 S2) 或長期 (L1) 。 針對標準環境,sku 會決定環境的容量、輸入費率和帳單費率。

tags
  • object

資源標籤

type
  • string

資源類型

StorageLimitExceededBehavior

當超過環境的容量時,時間序列深入解析服務應採取的行為。 如果指定 "PauseIngress",將不會從事件來源讀取新的事件。 如果指定了 "PurgeOldData",將會繼續讀取新的事件,並從環境中刪除舊的事件。 預設行為是 PurgeOldData。

Name Type Description
PauseIngress
  • string
PurgeOldData
  • string

TimeSeriesIdProperty

時間序列識別碼可擁有的屬性結構。 環境可以有多個這類屬性。

Name Type Description
name
  • string

屬性的名稱。

type

屬性的類型。

WarmStorageEnvironmentStatus

物件,表示環境中暖儲存體的狀態。

Name Type Description
propertiesUsage.state

此字串表示暖儲存體屬性使用狀況的狀態。 它可以是「確定」、「錯誤」、「未知」。

propertiesUsage.stateDetails.currentCount
  • integer

值,代表適用于 S1/S2 SKU 的環境所使用的屬性數目,以及 PAYG SKU 的暖存放區所使用的屬性數目。

propertiesUsage.stateDetails.maxCount
  • integer

值,代表適用于 S1/S2 SKU 的環境所允許的最大屬性數目,以及 PAYG SKU 之暖存放區所允許的最大屬性數目。

WarmStoragePropertiesState

此字串表示暖儲存體屬性使用狀況的狀態。 它可以是「確定」、「錯誤」、「未知」。

Name Type Description
Error
  • string
Ok
  • string
Unknown
  • string

WarmStoreConfigurationProperties

暖存放區設定會提供詳細資料來建立暖存放區快取,以保留環境資料的複本,以加快查詢速度。

Name Type Description
dataRetention
  • string

ISO8601 timespan,指定環境的事件可從暖存放區進行查詢的天數。