Application Definitions - Create Or Update

Referência

Service:: Managed Applications

API Version:: 2019-07-01

Cria uma nova definição de aplicativo gerenciado.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
applicationDefinitionName	path	True	string	O nome da definição do aplicativo gerenciado.
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas. Regex pattern: `^[-\w\._]+$`
subscriptionId	path	True	string	A ID da assinatura de destino.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
properties.lockLevel	True	ApplicationLockLevel	O nível de bloqueio do aplicativo gerenciado.
location		string	Localização do recurso
managedBy		string	ID do recurso que gerencia esse recurso.
properties.artifacts		ApplicationDefinitionArtifact[]	A coleção de artefatos de aplicativo gerenciado. O portal usará os arquivos especificados como artefatos para construir a experiência do usuário de criar um aplicativo gerenciado a partir de uma definição de aplicativo gerenciado.
properties.authorizations		ApplicationAuthorization[]	As autorizações do provedor de aplicativos gerenciados.
properties.createUiDefinition		object	O json createUiDefinition para o modelo de suporte com o recurso Microsoft.Solutions/applications. Pode ser uma cadeia de caracteres JSON JObject ou bem formada.
properties.deploymentPolicy		ApplicationDeploymentPolicy	A política de implantação de aplicativo gerenciado.
properties.description		string	A descrição da definição do aplicativo gerenciado.
properties.displayName		string	O nome de exibição da definição do aplicativo gerenciado.
properties.isEnabled		boolean	Um valor que indica se o pacote está habilitado ou não.
properties.lockingPolicy		ApplicationPackageLockingPolicyDefinition	A política de bloqueio de aplicativo gerenciado.
properties.mainTemplate		object	O json de modelo main embutido que tem recursos a serem provisionados. Pode ser uma cadeia de caracteres JSON JObject ou bem formada.
properties.managementPolicy		ApplicationManagementPolicy	A política de gerenciamento de aplicativos gerenciados que determina o acesso do editor ao grupo de recursos gerenciados.
properties.notificationPolicy		ApplicationNotificationPolicy	A política de notificação do aplicativo gerenciado.
properties.packageFileUri		string	O Uri do arquivo de pacote de definição de aplicativo gerenciado. Usar esse elemento
properties.policies		ApplicationPolicy[]	As políticas do provedor de aplicativos gerenciados.
sku		Sku	O SKU do recurso.
tags		object	Marcações de recursos

Respostas

Nome	Tipo	Description
200 OK	ApplicationDefinition	OK – retorna informações sobre a definição do aplicativo gerenciado, incluindo o provisionamento status.
201 Created	ApplicationDefinition	Criado – retorna informações sobre a definição do aplicativo gerenciado, incluindo o provisionamento status.
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Create or update managed application definition

Sample Request

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"
}

from typing import Any, IO, Union

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

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"
  }
}

Definições

Nome	Description
ApplicationArtifactType	O tipo de artefato do aplicativo gerenciado.
ApplicationAuthorization	A autorização do provedor de aplicativos gerenciados.
ApplicationDefinition	Informações sobre a definição de aplicativo gerenciado.
ApplicationDefinitionArtifact	Artefato de definição de aplicativo.
ApplicationDefinitionArtifactName	O nome do artefato do aplicativo gerenciado.
ApplicationDeploymentPolicy	Política de implantação de aplicativo gerenciado.
ApplicationLockLevel	O nível de bloqueio do aplicativo gerenciado.
ApplicationManagementMode	O modo de gerenciamento.
ApplicationManagementPolicy	Política de gerenciamento de aplicativos gerenciados.
ApplicationNotificationEndpoint	Ponto de extremidade de notificação de aplicativo gerenciado.
ApplicationNotificationPolicy	Política de notificação de aplicativo gerenciado.
ApplicationPackageLockingPolicyDefinition	Política de bloqueio de aplicativo gerenciado.
ApplicationPolicy	Política de aplicativo gerenciado.
DeploymentMode	O modo de implantação.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
Sku	SKU para o recurso.

ApplicationArtifactType

O tipo de artefato do aplicativo gerenciado.

Nome	Tipo	Description
Custom	string
NotSpecified	string
Template	string

ApplicationAuthorization

A autorização do provedor de aplicativos gerenciados.

Nome	Tipo	Description
principalId	string	O identificador principal do provedor. Essa é a identidade que o provedor usará para chamar o ARM para gerenciar os recursos do aplicativo gerenciado.
roleDefinitionId	string	O identificador de definição de função do provedor. Essa função definirá todas as permissões que o provedor deve ter no grupo de recursos de contêiner do aplicativo gerenciado. Essa definição de função não pode ter permissão para excluir o grupo de recursos.