Tenant Configuration - Save

Service:

API Management

API Version:

2022-08-01

Den här åtgärden skapar en incheckning med den aktuella konfigurationsögonblicksbilden till den angivna grenen på lagringsplatsen. Det här är en tidskrävande åtgärd som kan ta flera minuter att slutföra.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
configurationName	path	True	configurationIdName	Identifieraren för Git-konfigurationsåtgärden.
resourceGroupName	path	True	string	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
serviceName	path	True	string	Namnet på API Management-tjänsten. Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	ID för målprenumerationen.
api-version	query	True	string	Den API-version som ska användas för den här åtgärden.

Begärandetext

Name	Obligatorisk	Typ	Description
properties.branch	True	string	Namnet på Git-grenen där den aktuella konfigurationsögonblicksbilden ska checkas in.
properties.force		boolean	Värdet om det är sant, den aktuella konfigurationsdatabasen checkas in på Git-lagringsplatsen, även om Git-lagringsplatsen har nyare ändringar som skulle skrivas över.

Svar

Name	Typ	Description
200 OK	OperationResultContract	Resultatet av att skapa en incheckning på lagringsplatsen.
202 Accepted		Accepterad: Platsrubriken innehåller den URL där statusen för den långvariga åtgärden kan kontrolleras.
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

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	personifiera ditt användarkonto

Exempel

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": []
  }
}

Definitioner

Name	Description
AsyncOperationStatus	Status för en asynkron åtgärd.
configurationIdName	Identifieraren för Git-konfigurationsåtgärden.
ErrorFieldContract	Fel Fältkontrakt.
ErrorResponse	Felsvar.
ErrorResponseBody	Fel på brödtextkontrakt.
OperationResultContract	Git-åtgärdsresultat som körs länge.
OperationResultLogItemContract	Logg över entiteten som skapas, uppdateras eller tas bort.
SaveConfigurationParameter	Spara information om klientkonfigurationskontraktet.

AsyncOperationStatus

Status för en asynkron åtgärd.

Name	Typ	Description
Failed	string
InProgress	string
Started	string
Succeeded	string

configurationIdName

Identifieraren för Git-konfigurationsåtgärden.

Name	Typ	Description
configuration	string

ErrorFieldContract

Fel Fältkontrakt.

Name	Typ	Description
code	string	Felkod på egenskapsnivå.
message	string	Mänsklig läsbar representation av fel på egenskapsnivå.
target	string	Egenskapsnamn.

ErrorResponse

Felsvar.

Name	Typ	Description
error.code	string	Tjänstdefinierad felkod. Den här koden fungerar som en understatus för HTTP-felkoden som anges i svaret.
error.details	ErrorFieldContract[]	Listan över ogiltiga fält som skickas i begäran, om verifieringsfel uppstår.
error.message	string	Mänsklig läsbar representation av felet.

ErrorResponseBody

Fel på brödtextkontrakt.

Name	Typ	Description
code	string	Tjänstdefinierad felkod. Den här koden fungerar som en understatus för HTTP-felkoden som anges i svaret.
details	ErrorFieldContract[]	Listan över ogiltiga fält som skickas i begäran, om verifieringsfel uppstår.
message	string	Mänsklig läsbar representation av felet.

OperationResultContract

Git-åtgärdsresultat som körs länge.

Name	Typ	Description
id	string	Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Namnet på resursen
properties.actionLog	OperationResultLogItemContract[]	Den här egenskapen tillhandahålls endast som en del av åtgärden TenantConfiguration_Validate. Den innehåller loggen de entiteter som ska uppdateras/skapas/tas bort som en del av den TenantConfiguration_Deploy åtgärden.
properties.error	ErrorResponseBody	Fel på brödtextkontrakt
properties.id	string	Åtgärdsresultatidentifierare.
properties.resultInfo	string	Valfri resultatinformation.
properties.started	string	Starttid för en asynkron åtgärd. Datumet överensstämmer med följande format: yyyy-MM-ddTHH:mm:ssZ enligt iso 8601-standarden.
properties.status	AsyncOperationStatus	Status för en asynkron åtgärd.
properties.updated	string	Senaste uppdateringstid för en asynkron åtgärd. Datumet överensstämmer med följande format: yyyy-MM-ddTHH:mm:ssZ enligt iso 8601-standarden.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

OperationResultLogItemContract

Logg över entiteten som skapas, uppdateras eller tas bort.

Name	Typ	Description
action	string	Åtgärd som att skapa/uppdatera/ta bort.
objectKey	string	Identifierare för entiteten som skapas/uppdateras/tas bort.
objectType	string	Typen av entitetskontrakt.

SaveConfigurationParameter

Spara information om klientkonfigurationskontraktet.

Name	Typ	Description
properties.branch	string	Namnet på Git-grenen där den aktuella konfigurationsögonblicksbilden ska checkas in.
properties.force	boolean	Värdet om det är sant, den aktuella konfigurationsdatabasen checkas in på Git-lagringsplatsen, även om Git-lagringsplatsen har nyare ändringar som skulle skrivas över.