Application Definitions - Create Or Update

Service:

Managed Applications

API Version:

2019-07-01

建立新的受控應用程式定義。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/applicationDefinitions/{applicationDefinitionName}?api-version=2019-07-01

URI 參數

名稱	位於	必要	類型	Description
applicationDefinitionName	path	True	string	受控應用程式定義的名稱。
resourceGroupName	path	True	string	資源群組的名稱。 名稱不區分大小寫。 Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	目標訂用帳戶的標識碼。
api-version	query	True	string	用於此作業的 API 版本。

要求本文

名稱	必要	類型	Description
properties.lockLevel	True	ApplicationLockLevel	受控應用程式鎖定層級。
location		string	資源位置
managedBy		string	管理此資源之資源的識別碼。
properties.artifacts		ApplicationDefinitionArtifact[]	受控應用程式成品的集合。 入口網站會使用指定為成品的檔案，建構從受控應用程式定義建立受控應用程式的用戶體驗。
properties.authorizations		ApplicationAuthorization[]	受控應用程式提供者授權。
properties.createUiDefinition		object	使用 Microsoft.Solutions/applications 資源的備份範本 createUiDefinition json。 它可以是 JObject 或格式正確的 JSON 字串。
properties.deploymentPolicy		ApplicationDeploymentPolicy	受控應用程式部署原則。
properties.description		string	受控應用程式定義描述。
properties.displayName		string	受控應用程式定義顯示名稱。
properties.isEnabled		boolean	值，指出是否啟用封裝。
properties.lockingPolicy		ApplicationPackageLockingPolicyDefinition	受控應用程式鎖定原則。
properties.mainTemplate		object	內嵌主要範本 json，其中包含要布建的資源。 它可以是 JObject 或格式正確的 JSON 字串。
properties.managementPolicy		ApplicationManagementPolicy	受控應用程式管理原則，決定發行者對受控資源群組的存取權。
properties.notificationPolicy		ApplicationNotificationPolicy	受控應用程式通知原則。
properties.packageFileUri		string	受控應用程式定義封裝檔案Uri。 使用這個專案
properties.policies		ApplicationPolicy[]	受控應用程式提供者原則。
sku		Sku	資源的 SKU。
tags		object	資源標籤

回應

名稱	類型	Description
200 OK	ApplicationDefinition	確定 - 傳回受控應用程式定義的相關信息，包括布建狀態。
201 Created	ApplicationDefinition	建立 - 傳回受控應用程式定義的相關信息，包括布建狀態。
Other Status Codes	ErrorResponse	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

Create or update managed application definition

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Solutions/applicationDefinitions/myManagedApplicationDef?api-version=2019-07-01

{
  "properties": {
    "lockLevel": "None",
    "displayName": "myManagedApplicationDef",
    "description": "myManagedApplicationDef description",
    "authorizations": [
      {
        "principalId": "validprincipalguid",
        "roleDefinitionId": "validroleguid"
      }
    ],
    "packageFileUri": "https://path/to/packagezipfile"
  },
  "location": "East US 2"
}

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.resource import ApplicationClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-resource
# USAGE
    python create_or_update_application_definition.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApplicationClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.application_definitions.begin_create_or_update(
        resource_group_name="rg",
        application_definition_name="myManagedApplicationDef",
        parameters={
            "location": "East US 2",
            "properties": {
                "authorizations": [{"principalId": "validprincipalguid", "roleDefinitionId": "validroleguid"}],
                "description": "myManagedApplicationDef description",
                "displayName": "myManagedApplicationDef",
                "lockLevel": "None",
                "packageFileUri": "https://path/to/packagezipfile",
            },
        },
    ).result()
    print(response)


# x-ms-original-file: specification/resources/resource-manager/Microsoft.Solutions/stable/2019-07-01/examples/createOrUpdateApplicationDefinition.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Resources.Models;

// Generated from example definition: specification/resources/resource-manager/Microsoft.Solutions/stable/2019-07-01/examples/createOrUpdateApplicationDefinition.json
// this example is just showing the usage of "ApplicationDefinitions_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "subid";
string resourceGroupName = "rg";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this ArmApplicationDefinitionResource
ArmApplicationDefinitionCollection collection = resourceGroupResource.GetArmApplicationDefinitions();

// invoke the operation
string applicationDefinitionName = "myManagedApplicationDef";
ArmApplicationDefinitionData data = new ArmApplicationDefinitionData(new AzureLocation("East US 2"), ArmApplicationLockLevel.None)
{
    DisplayName = "myManagedApplicationDef",
    Authorizations =
    {
    new ArmApplicationAuthorization(Guid.Parse("validprincipalguid"),"validroleguid")
    },
    Description = "myManagedApplicationDef description",
    PackageFileUri = new Uri("https://path/to/packagezipfile"),
};
ArmOperation<ArmApplicationDefinitionResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, applicationDefinitionName, data);
ArmApplicationDefinitionResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ArmApplicationDefinitionData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

{
  "name": "myManagedApplicationDef",
  "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Solutions/applicationDefinitions/myManagedApplicationDef",
  "type": "Microsoft.Solutions/applicationDefinitions",
  "location": "East US 2",
  "managedBy": null,
  "tags": null,
  "sku": null,
  "properties": {
    "artifacts": [
      {
        "name": "CreateUiDefinition",
        "type": "Custom",
        "uri": "https://path/to/managedApplicationCreateUiDefinition.json"
      },
      {
        "name": "ApplicationResourceTemplate",
        "type": "Template",
        "uri": "https://path/to/mainTemplate.json"
      }
    ],
    "authorizations": [
      {
        "principalId": "validprincipalguid",
        "roleDefinitionId": "validroleguid"
      }
    ],
    "description": "myManagedApplicationDef description",
    "displayName": "myManagedApplicationDef",
    "lockLevel": "None",
    "packageFileUri": "https://path/to/packagezipfile"
  }
}

Status code:

201

{
  "name": "myManagedApplicationDef",
  "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Solutions/applicationDefinitions/myManagedApplicationDef",
  "type": "Microsoft.Solutions/applicationDefinitions",
  "location": "East US 2",
  "managedBy": null,
  "tags": null,
  "sku": null,
  "properties": {
    "artifacts": [
      {
        "name": "CreateUiDefinition",
        "type": "Custom",
        "uri": "https://path/to/managedApplicationCreateUiDefinition.json"
      },
      {
        "name": "ApplicationResourceTemplate",
        "type": "Template",
        "uri": "https://path/to/mainTemplate.json"
      }
    ],
    "authorizations": [
      {
        "principalId": "validprincipalguid",
        "roleDefinitionId": "validroleguid"
      }
    ],
    "description": "myManagedApplicationDef description",
    "displayName": "myManagedApplicationDef",
    "lockLevel": "None",
    "packageFileUri": "https://path/to/packagezipfile"
  }
}

定義

名稱	Description
ApplicationArtifactType	受控應用程式成品類型。
ApplicationAuthorization	受控應用程式提供者授權。
ApplicationDefinition	受控應用程式定義的相關信息。
ApplicationDefinitionArtifact	應用程式定義成品。
ApplicationDefinitionArtifactName	受控應用程式成品名稱。
ApplicationDeploymentPolicy	受控應用程式部署原則。
ApplicationLockLevel	受控應用程式鎖定層級。
ApplicationManagementMode	管理模式。
ApplicationManagementPolicy	受控應用程式管理原則。
ApplicationNotificationEndpoint	受控應用程式通知端點。
ApplicationNotificationPolicy	受控應用程式通知原則。
ApplicationPackageLockingPolicyDefinition	受控應用程式鎖定原則。
ApplicationPolicy	受控應用程式原則。
DeploymentMode	部署模式。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
Sku	資源的 SKU。

ApplicationArtifactType

受控應用程式成品類型。

名稱	類型	Description
Custom	string
NotSpecified	string
Template	string

ApplicationAuthorization

受控應用程式提供者授權。

名稱	類型	Description
principalId	string	提供者的主體標識碼。 這是提供者將用來呼叫ARM來管理受控應用程式資源的身分識別。
roleDefinitionId	string	提供者的角色定義標識碼。 此角色會定義提供者在受控應用程式的容器資源群組上必須擁有的所有許可權。 這個角色定義不能有刪除資源群組的許可權。

ApplicationDefinition

受控應用程式定義的相關信息。

名稱	類型	Description
id	string	資源識別碼
location	string	資源位置
managedBy	string	管理此資源之資源的識別碼。
name	string	資源名稱
properties.artifacts	ApplicationDefinitionArtifact[]	受控應用程式成品的集合。 入口網站會使用指定為成品的檔案，建構從受控應用程式定義建立受控應用程式的用戶體驗。
properties.authorizations	ApplicationAuthorization[]	受控應用程式提供者授權。
properties.createUiDefinition	object	使用 Microsoft.Solutions/applications 資源的備份範本 createUiDefinition json。 它可以是 JObject 或格式正確的 JSON 字串。
properties.deploymentPolicy	ApplicationDeploymentPolicy	受控應用程式部署原則。
properties.description	string	受控應用程式定義描述。
properties.displayName	string	受控應用程式定義顯示名稱。
properties.isEnabled	boolean	值，指出是否啟用封裝。
properties.lockLevel	ApplicationLockLevel	受控應用程式鎖定層級。
properties.lockingPolicy	ApplicationPackageLockingPolicyDefinition	受控應用程式鎖定原則。
properties.mainTemplate	object	內嵌主要範本 json，其中包含要布建的資源。 它可以是 JObject 或格式正確的 JSON 字串。
properties.managementPolicy	ApplicationManagementPolicy	受控應用程式管理原則，決定發行者對受控資源群組的存取權。
properties.notificationPolicy	ApplicationNotificationPolicy	受控應用程式通知原則。
properties.packageFileUri	string	受控應用程式定義封裝檔案Uri。 使用這個專案
properties.policies	ApplicationPolicy[]	受控應用程式提供者原則。
sku	Sku	資源的 SKU。
tags	object	資源標籤
type	string	資源類型

ApplicationDefinitionArtifact

應用程式定義成品。

名稱	類型	Description
name	ApplicationDefinitionArtifactName	受控應用程式定義成品名稱。
type	ApplicationArtifactType	受控應用程式定義成品類型。
uri	string	受控應用程式定義成品 Blob URI。

ApplicationDefinitionArtifactName

受控應用程式成品名稱。

名稱	類型	Description
ApplicationResourceTemplate	string
CreateUiDefinition	string
MainTemplateParameters	string
NotSpecified	string

ApplicationDeploymentPolicy

受控應用程式部署原則。

名稱	類型	Description
deploymentMode	DeploymentMode	受控應用程式部署模式。

ApplicationLockLevel

受控應用程式鎖定層級。

名稱	類型	Description
CanNotDelete	string
None	string
ReadOnly	string

ApplicationManagementMode

管理模式。

名稱	類型	Description
Managed	string
NotSpecified	string
Unmanaged	string

ApplicationManagementPolicy

受控應用程式管理原則。

名稱	類型	Description
mode	ApplicationManagementMode	受控應用程式管理模式。

ApplicationNotificationEndpoint

受控應用程式通知端點。

名稱	類型	Description
uri	string	受控應用程式通知端點 URI。

ApplicationNotificationPolicy

受控應用程式通知原則。

名稱	類型	Description
notificationEndpoints	ApplicationNotificationEndpoint[]	受控應用程式通知端點。

ApplicationPackageLockingPolicyDefinition

受控應用程式鎖定原則。

名稱	類型	Description
allowedActions	string[]	拒絕指派排除的動作。
allowedDataActions	string[]	拒絕指派排除的數據動作。

ApplicationPolicy

受控應用程式原則。

名稱	類型	Description
name	string	原則名稱
parameters	string	原則參數。
policyDefinitionId	string	原則定義標識碼。

DeploymentMode

部署模式。

名稱	類型	Description
Complete	string
Incremental	string
NotSpecified	string

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細資料。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

Sku

資源的 SKU。

名稱	類型	Description
capacity	integer	SKU 容量。
family	string	SKU 系列。
model	string	SKU 模型。
name	string	SKU 名稱。
size	string	SKU 大小。
tier	string	SKU 層。