Tenant Configuration - Deploy
Bu işlem, belirtilen Git dalındaki değişiklikleri yapılandırma veritabanına uygular. Bu uzun süre çalışan bir işlemdir ve tamamlanması birkaç dakika sürebilir.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/configuration/deploy?api-version=2022-08-01
URI Parametreleri
Name | İçinde | Gerekli | Tür | Description |
---|---|---|---|---|
configuration
|
path | True |
Git Yapılandırma İşleminin tanımlayıcısı. |
|
resource
|
path | True |
string |
Kaynak grubunun adı. Ad büyük/küçük harfe duyarlı değildir. |
service
|
path | True |
string |
API Management hizmetinin adı. Regex pattern: |
subscription
|
path | True |
string |
Hedef aboneliğin kimliği. |
api-version
|
query | True |
string |
Bu işlem için kullanılacak API sürümü. |
İstek Gövdesi
Name | Gerekli | Tür | Description |
---|---|---|---|
properties.branch | True |
string |
Yapılandırmanın yapılandırma veritabanına dağıtılacağı Git dalının adı. |
properties.force |
boolean |
Bu güncelleştirmede silinen ürünlere abonelik silmeyi zorunlu kılma değeri. |
Yanıtlar
Name | Tür | Description |
---|---|---|
200 OK |
Git dalından veritabanına değişiklik uygulamanın sonucu. |
|
202 Accepted |
Kabul edildi: Konum üst bilgisi, uzun süre çalışan işlemin durumunun denetlenebileceği URL'yi içerir. |
|
Other Status Codes |
İşlemin neden başarısız olduğunu açıklayan hata yanıtı. |
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
ApiManagementTenantConfigurationDeploy
Sample Request
POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/configuration/deploy?api-version=2022-08-01
{
"properties": {
"branch": "master"
}
}
Sample Response
location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5a1af4ae2a6d2e0b688d7517?api-version=2022-08-01
{
"id": "6074e652093a9d0dac3d733c",
"type": "Microsoft.ApiManagement/service/tenant/operationResults",
"name": "6074e652093a9d0dac3d733c",
"properties": {
"status": "Failed",
"started": "2017-11-26T17:06:54.303Z",
"updated": "2017-11-26T17:07:21.777Z",
"error": {
"code": "ValidationError",
"message": "File not found: 'api-management/configuration.json'"
}
}
}
Tanımlar
Name | Description |
---|---|
Async |
Zaman uyumsuz işlemin durumu. |
configuration |
Git Yapılandırma İşleminin tanımlayıcısı. |
Deploy |
Kiracı Yapılandırma Sözleşmesi'ne dağıtma. |
Error |
Hata Alanı sözleşmesi. |
Error |
Hata Yanıtı. |
Error |
Hata Gövdesi sözleşmesi. |
Operation |
Uzun Süre Çalışan Git İşlem Sonuçları. |
Operation |
Oluşturulan, güncelleştirilen veya silinen varlığın günlüğü. |
AsyncOperationStatus
Zaman uyumsuz işlemin durumu.
Name | Tür | Description |
---|---|---|
Failed |
string |
|
InProgress |
string |
|
Started |
string |
|
Succeeded |
string |
configurationIdName
Git Yapılandırma İşleminin tanımlayıcısı.
Name | Tür | Description |
---|---|---|
configuration |
string |
DeployConfigurationParameters
Kiracı Yapılandırma Sözleşmesi'ne dağıtma.
Name | Tür | Description |
---|---|---|
properties.branch |
string |
Yapılandırmanın yapılandırma veritabanına dağıtılacağı Git dalının adı. |
properties.force |
boolean |
Bu güncelleştirmede silinen ürünlere abonelik silmeyi zorunlu kılma değeri. |
ErrorFieldContract
Hata Alanı sözleşmesi.
Name | Tür | Description |
---|---|---|
code |
string |
Özellik düzeyi hata kodu. |
message |
string |
Özellik düzeyi hatanın insan tarafından okunabilir gösterimi. |
target |
string |
Özellik adı. |
ErrorResponse
Hata Yanıtı.
Name | Tür | Description |
---|---|---|
error.code |
string |
Hizmet tanımlı hata kodu. Bu kod, yanıtta belirtilen HTTP hata kodu için bir alt durum görevi görür. |
error.details |
Doğrulama hatası durumunda istekte gönderilen geçersiz alanların listesi. |
|
error.message |
string |
Hatanın insan tarafından okunabilen gösterimi. |
ErrorResponseBody
Hata Gövdesi sözleşmesi.
Name | Tür | Description |
---|---|---|
code |
string |
Hizmet tanımlı hata kodu. Bu kod, yanıtta belirtilen HTTP hata kodu için bir alt durum görevi görür. |
details |
Doğrulama hatası durumunda istekte gönderilen geçersiz alanların listesi. |
|
message |
string |
Hatanın insan tarafından okunabilen gösterimi. |
OperationResultContract
Uzun Süre Çalışan Git İşlem Sonuçları.
Name | Tür | Description |
---|---|---|
id |
string |
Kaynağın tam kaynak kimliği. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Kaynağın adı |
properties.actionLog |
Bu özellik yalnızca TenantConfiguration_Validate işleminin bir parçası olarak sağlanıyorsa. TenantConfiguration_Deploy işleminin bir parçası olarak güncelleştirilecek/oluşturulacak/silinecek varlıkların günlüğünü içerir. |
|
properties.error |
Hata Gövdesi Sözleşmesi |
|
properties.id |
string |
İşlem sonucu tanımlayıcısı. |
properties.resultInfo |
string |
İsteğe bağlı sonuç bilgileri. |
properties.started |
string |
Zaman uyumsuz işlemin başlangıç zamanı. Tarih şu biçime uygundur: |
properties.status |
Zaman uyumsuz işlemin durumu. |
|
properties.updated |
string |
Zaman uyumsuz işlemin son güncelleştirme zamanı. Tarih şu biçime uygundur: |
type |
string |
Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts" |
OperationResultLogItemContract
Oluşturulan, güncelleştirilen veya silinen varlığın günlüğü.
Name | Tür | Description |
---|---|---|
action |
string |
Oluşturma/güncelleştirme/silme gibi eylemler. |
objectKey |
string |
Oluşturulan/güncelleştirilen/silinen varlığın tanımlayıcısı. |
objectType |
string |
Varlık sözleşmesinin türü. |