Api Release - Create Or Update
建立 API 的新版本。
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/releases/{releaseId}?api-version=2021-08-01
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
api
|
path | True |
string |
API 識別碼。 在目前 API 管理 服務實例中必須是唯一的。 |
release
|
path | True |
string |
API 內的發行標識碼。 在目前 API 管理 服務實例中必須是唯一的。 Regex 模式: |
resource
|
path | True |
string |
資源群組的名稱。 |
service
|
path | True |
string |
API 管理 服務的名稱。 Regex 模式: |
subscription
|
path | True |
string |
可唯一識別 Microsoft Azure 訂用帳戶的訂用帳戶認證。 訂用帳戶識別碼會構成每個服務呼叫 URI 的一部分。 |
api-version
|
query | True |
string |
要與用戶端要求搭配使用的 API 版本。 |
要求標頭
名稱 | 必要 | 類型 | Description |
---|---|---|---|
If-Match |
string |
實體的 ETag。 建立實體時不需要,但在更新實體時則為必要專案。 |
要求本文
名稱 | 類型 | Description |
---|---|---|
properties.apiId |
string |
發行所屬 API 的識別碼。 |
properties.notes |
string |
版本資訊 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
已成功更新發行。 標題 ETag: string |
|
201 Created |
已成功建立發行。 標題 ETag: string |
|
Other Status Codes |
描述作業失敗原因的錯誤回應。 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow。
類型:
oauth2
Flow:
implicit
授權 URL:
https://login.microsoftonline.com/common/oauth2/authorize
範圍
名稱 | Description |
---|---|
user_impersonation | 模擬您的用戶帳戶 |
範例
ApiManagementCreateApiRelease
範例要求
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1/releases/testrev?api-version=2021-08-01
{
"properties": {
"apiId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1",
"notes": "yahooagain"
}
}
範例回覆
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1/releases/testrev",
"type": "Microsoft.ApiManagement/service/apis/releases",
"name": "testrev",
"properties": {
"apiId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1",
"createdDateTime": "2018-02-08T20:52:00.65Z",
"updatedDateTime": "2018-02-08T20:52:00.65Z",
"notes": "yahooagain"
}
}
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1/releases/testrev",
"type": "Microsoft.ApiManagement/service/apis/releases",
"name": "testrev",
"properties": {
"apiId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1",
"createdDateTime": "2018-02-08T20:52:00.65Z",
"updatedDateTime": "2018-02-08T20:52:00.65Z",
"notes": "yahooagain"
}
}
定義
名稱 | Description |
---|---|
Api |
ApiRelease 詳細數據。 |
Error |
錯誤欄位合約。 |
Error |
錯誤回應。 |
ApiReleaseContract
ApiRelease 詳細數據。
名稱 | 類型 | Description |
---|---|---|
id |
string |
資源的完整資源識別碼。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
資源的名稱 |
properties.apiId |
string |
發行所屬 API 的識別碼。 |
properties.createdDateTime |
string |
API 發行的時間。 日期符合下列格式:yyyy-MM-ddTHH:mm:ssZ,如 ISO 8601 標準所指定。 |
properties.notes |
string |
版本資訊 |
properties.updatedDateTime |
string |
API 發行的時間。 |
type |
string |
資源類型。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts” |
ErrorFieldContract
錯誤欄位合約。
名稱 | 類型 | Description |
---|---|---|
code |
string |
屬性層級錯誤碼。 |
message |
string |
人類可讀取的屬性層級錯誤表示法。 |
target |
string |
屬性名稱。 |
ErrorResponse
錯誤回應。
名稱 | 類型 | Description |
---|---|---|
error.code |
string |
服務定義的錯誤碼。 此代碼會作為回應中指定之 HTTP 錯誤碼的子狀態。 |
error.details |
要求中傳送無效欄位的清單,以防發生驗證錯誤。 |
|
error.message |
string |
人類可閱讀的錯誤表示法。 |