Tenant Configuration - Save

Service:

API Management

API Version:

2022-08-01

Esta operação cria uma consolidação com o instantâneo de configuração atual para o ramo especificado no repositório. Trata-se de uma operação de execução prolongada e pode demorar vários minutos a concluir.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/configuration/save?api-version=2022-08-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
configurationName	path	True	configurationIdName	O identificador da Operação de Configuração do Git.
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
serviceName	path	True	string	O nome do serviço Gestão de API. Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	O ID da subscrição de destino.
api-version	query	True	string	A versão da API a utilizar para esta operação.

Corpo do Pedido

Name	Necessário	Tipo	Description
properties.branch	True	string	O nome do ramo git no qual se consolida o instantâneo de configuração atual.
properties.force		boolean	O valor, se for verdadeiro, a base de dados de configuração atual é consolidada no repositório Git, mesmo que o repositório git tenha alterações mais recentes que seriam substituídas.

Respostas

Name	Tipo	Description
200 OK	OperationResultContract	Resultado da criação de uma consolidação no repositório.
202 Accepted		Aceite: o cabeçalho de localização contém o URL onde o estado da operação de execução prolongada pode ser verificado.
Other Status Codes	ErrorResponse	Resposta de erro que descreve a razão pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Scopes

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

ApiManagementTenantConfigurationSave

Sample Request

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/configuration/save?api-version=2022-08-01

{
  "properties": {
    "branch": "master"
  }
}

Java

import com.azure.resourcemanager.apimanagement.models.ConfigurationIdName;
import com.azure.resourcemanager.apimanagement.models.SaveConfigurationParameter;

/** Samples for TenantConfiguration Save. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementTenantConfigurationSave.json
     */
    /**
     * Sample code: ApiManagementTenantConfigurationSave.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementTenantConfigurationSave(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .tenantConfigurations()
            .save(
                "rg1",
                "apimService1",
                ConfigurationIdName.CONFIGURATION,
                new SaveConfigurationParameter().withBranch("master"),
                com.azure.core.util.Context.NONE);
    }
}

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

Python

from typing import Any, IO, TYPE_CHECKING, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.apimanagement import ApiManagementClient

if TYPE_CHECKING:
    # pylint: disable=unused-import,ungrouped-imports
    from .. import models as _models
"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_tenant_configuration_save.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 = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.tenant_configuration.begin_save(
        resource_group_name="rg1",
        service_name="apimService1",
        configuration_name="configuration",
        parameters={"properties": {"branch": "master"}},
    ).result()
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementTenantConfigurationSave.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

Go

package armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementTenantConfigurationSave.json
func ExampleTenantConfigurationClient_BeginSave() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewTenantConfigurationClient().BeginSave(ctx, "rg1", "apimService1", armapimanagement.ConfigurationIDNameConfiguration, armapimanagement.SaveConfigurationParameter{
		Properties: &armapimanagement.SaveConfigurationParameterProperties{
			Branch: to.Ptr("master"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.OperationResultContract = armapimanagement.OperationResultContract{
	// 	Name: to.Ptr("6074e652093a9d0dac3d733c"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/tenant/operationResults"),
	// 	ID: to.Ptr("6074e652093a9d0dac3d733c"),
	// 	Properties: &armapimanagement.OperationResultContractProperties{
	// 		ActionLog: []*armapimanagement.OperationResultLogItemContract{
	// 		},
	// 		ResultInfo: to.Ptr("The configuration was successfully saved to master as commit c0ae274f6046912107bad734834cbf65918668b6."),
	// 		Started: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-04-13T00:31:14.940Z"); return t}()),
	// 		Status: to.Ptr(armapimanagement.AsyncOperationStatusSucceeded),
	// 		Updated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-04-13T00:31:27.590Z"); return t}()),
	// 	},
	// }
}

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

JavaScript

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to This operation creates a commit with the current configuration snapshot to the specified branch in the repository. This is a long running operation and could take several minutes to complete.
 *
 * @summary This operation creates a commit with the current configuration snapshot to the specified branch in the repository. This is a long running operation and could take several minutes to complete.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementTenantConfigurationSave.json
 */
async function apiManagementTenantConfigurationSave() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const configurationName = "configuration";
  const parameters = { branch: "master" };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.tenantConfiguration.beginSaveAndWait(
    resourceGroupName,
    serviceName,
    configurationName,
    parameters
  );
  console.log(result);
}

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:

202

location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5a1af57d2a6d2e0b688d751b?api-version=2022-08-01

Status code:

200

{
  "id": "6074e652093a9d0dac3d733c",
  "type": "Microsoft.ApiManagement/service/tenant/operationResults",
  "name": "6074e652093a9d0dac3d733c",
  "properties": {
    "status": "Succeeded",
    "started": "2021-04-13T00:31:14.94Z",
    "updated": "2021-04-13T00:31:27.59Z",
    "resultInfo": "The configuration was successfully saved to master as commit c0ae274f6046912107bad734834cbf65918668b6.",
    "actionLog": []
  }
}

Definições

Name	Description
AsyncOperationStatus	Estado de uma operação assíncrona.
configurationIdName	O identificador da Operação de Configuração do Git.
ErrorFieldContract	Contrato de campo de erro.
ErrorResponse	Resposta a Erros.
ErrorResponseBody	Contrato do Corpo do Erro.
OperationResultContract	Resultados da Operação Git de Execução Prolongada.
OperationResultLogItemContract	Registo da entidade a ser criada, atualizada ou eliminada.
SaveConfigurationParameter	Guarde os detalhes do Contrato de Configuração do Inquilino.

AsyncOperationStatus

Estado de uma operação assíncrona.

Name	Tipo	Description
Failed	string
InProgress	string
Started	string
Succeeded	string

configurationIdName

O identificador da Operação de Configuração do Git.

Name	Tipo	Description
configuration	string

ErrorFieldContract

Contrato de campo de erro.

Name	Tipo	Description
code	string	Código de erro ao nível da propriedade.
message	string	Representação legível por humanos do erro ao nível da propriedade.
target	string	Nome da propriedade.

ErrorResponse

Resposta a Erros.

Name	Tipo	Description
error.code	string	Código de erro definido pelo serviço. Este código serve como um sub-estado para o código de erro HTTP especificado na resposta.
error.details	ErrorFieldContract[]	A lista de campos inválidos enviados a pedido, em caso de erro de validação.
error.message	string	Representação legível por humanos do erro.

ErrorResponseBody

Contrato do Corpo do Erro.

Name	Tipo	Description
code	string	Código de erro definido pelo serviço. Este código serve como um sub-estado para o código de erro HTTP especificado na resposta.
details	ErrorFieldContract[]	A lista de campos inválidos enviados a pedido, em caso de erro de validação.
message	string	Representação legível por humanos do erro.

OperationResultContract

Resultados da Operação Git de Execução Prolongada.

Name	Tipo	Description
id	string	ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties.actionLog	OperationResultLogItemContract[]	Esta propriedade, se apenas for fornecida como parte da operação de TenantConfiguration_Validate. Contém o registo das entidades que serão atualizadas/criadas/eliminadas como parte da operação de TenantConfiguration_Deploy.
properties.error	ErrorResponseBody	Contrato do Corpo do Erro
properties.id	string	Identificador do resultado da operação.
properties.resultInfo	string	Informações de resultados opcionais.
properties.started	string	Hora de início de uma operação assíncrona. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pela norma ISO 8601.
properties.status	AsyncOperationStatus	Estado de uma operação assíncrona.
properties.updated	string	Hora da última atualização de uma operação assíncrona. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pela norma ISO 8601.
type	string	O tipo de recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

OperationResultLogItemContract

Registo da entidade a ser criada, atualizada ou eliminada.

Name	Tipo	Description
action	string	Ação como criar/atualizar/eliminar.
objectKey	string	Identificador da entidade que está a ser criada/atualizada/eliminada.
objectType	string	O tipo de contrato de entidade.

SaveConfigurationParameter

Guarde os detalhes do Contrato de Configuração do Inquilino.

Name	Tipo	Description
properties.branch	string	O nome do ramo git no qual se consolida o instantâneo de configuração atual.
properties.force	boolean	O valor, se for verdadeiro, a base de dados de configuração atual é consolidada no repositório Git, mesmo que o repositório git tenha alterações mais recentes que seriam substituídas.