Tenant Configuration - Validate

Service:

API Management

API Version:

2022-08-01

Tato operace ověří změny v zadané větvi Gitu. Jedná se o dlouhotrvající operaci, která může trvat několik minut.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
configurationName	path	True	configurationIdName	Identifikátor operace konfigurace Gitu.
resourceGroupName	path	True	string	Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.
serviceName	path	True	string	Název služby API Management. Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	ID cílového předplatného.
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Vyžadováno	Typ	Description
properties.branch	True	string	Název větve Gitu, ze které se má konfigurace nasadit do konfigurační databáze.
properties.force		boolean	Hodnota vynucující odstranění předplatných produktů, které jsou odstraněny v této aktualizaci.

Odpovědi

Name	Typ	Description
200 OK	OperationResultContract	Výsledek ověření změn v zadané větvi Gitu
202 Accepted		Přijato: Hlavička umístění obsahuje adresu URL, kde je možné zkontrolovat stav dlouhotrvající operace.
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

Scopes

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

ApiManagementTenantConfigurationValidate

Sample Request

HTTP

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

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

Java

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

/** Samples for TenantConfiguration Validate. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementTenantConfigurationValidate.json
     */
    /**
     * Sample code: ApiManagementTenantConfigurationValidate.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementTenantConfigurationValidate(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .tenantConfigurations()
            .validate(
                "rg1",
                "apimService1",
                ConfigurationIdName.CONFIGURATION,
                new DeployConfigurationParameters().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_validate.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_validate(
        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/ApiManagementTenantConfigurationValidate.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/ApiManagementTenantConfigurationValidate.json
func ExampleTenantConfigurationClient_BeginValidate() {
	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().BeginValidate(ctx, "rg1", "apimService1", armapimanagement.ConfigurationIDNameConfiguration, armapimanagement.DeployConfigurationParameters{
		Properties: &armapimanagement.DeployConfigurationParameterProperties{
			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("6074ec02093a9d0dac3d7345"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/tenant/operationResults"),
	// 	ID: to.Ptr("6074ec02093a9d0dac3d7345"),
	// 	Properties: &armapimanagement.OperationResultContractProperties{
	// 		ActionLog: []*armapimanagement.OperationResultLogItemContract{
	// 		},
	// 		ResultInfo: to.Ptr("Validation is successfull"),
	// 		Started: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-04-13T00:55:30.620Z"); return t}()),
	// 		Status: to.Ptr(armapimanagement.AsyncOperationStatusSucceeded),
	// 		Updated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-04-13T00:55:39.857Z"); 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 validates the changes in the specified Git branch. This is a long running operation and could take several minutes to complete.
 *
 * @summary This operation validates the changes in the specified Git branch. 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/ApiManagementTenantConfigurationValidate.json
 */
async function apiManagementTenantConfigurationValidate() {
  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.beginValidateAndWait(
    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/5a1af64e2a6d2e0b688d751e?api-version=2022-08-01

Status code:

200

{
  "id": "6074ec02093a9d0dac3d7345",
  "type": "Microsoft.ApiManagement/service/tenant/operationResults",
  "name": "6074ec02093a9d0dac3d7345",
  "properties": {
    "status": "Succeeded",
    "started": "2021-04-13T00:55:30.62Z",
    "updated": "2021-04-13T00:55:39.857Z",
    "resultInfo": "Validation is successfull",
    "actionLog": []
  }
}

Definice

Name	Description
AsyncOperationStatus	Stav asynchronní operace.
configurationIdName	Identifikátor operace konfigurace Gitu.
DeployConfigurationParameters	Nasazení kontraktu konfigurace tenanta.
ErrorFieldContract	Chyba Kontrakt pole.
ErrorResponse	Odpověď na chybu.
ErrorResponseBody	Chyba v textu kontraktu.
OperationResultContract	Výsledky dlouhotrvající operace Gitu
OperationResultLogItemContract	Protokol vytvářené, aktualizované nebo odstraněné entity

AsyncOperationStatus

Stav asynchronní operace.

Name	Typ	Description
Failed	string
InProgress	string
Started	string
Succeeded	string

configurationIdName

Identifikátor operace konfigurace Gitu.

Name	Typ	Description
configuration	string

DeployConfigurationParameters

Nasazení kontraktu konfigurace tenanta.

Name	Typ	Description
properties.branch	string	Název větve Gitu, ze které se má konfigurace nasadit do konfigurační databáze.
properties.force	boolean	Hodnota vynucující odstranění předplatných produktů, které jsou odstraněny v této aktualizaci.

ErrorFieldContract

Chyba Kontrakt pole.

Name	Typ	Description
code	string	Kód chyby na úrovni vlastnosti.
message	string	Čitelné znázornění chyby na úrovni vlastností.
target	string	Název vlastnosti.

ErrorResponse

Odpověď na chybu.

Name	Typ	Description
error.code	string	Kód chyby definované službou Tento kód slouží jako dílčí stav pro kód chyby HTTP zadaný v odpovědi.
error.details	ErrorFieldContract[]	Seznam neplatných polí se odešle v žádosti v případě chyby ověření.
error.message	string	Znázornění chyby čitelné pro člověka

ErrorResponseBody

Chyba v textu kontraktu.

Name	Typ	Description
code	string	Kód chyby definované službou Tento kód slouží jako dílčí stav pro kód chyby HTTP zadaný v odpovědi.
details	ErrorFieldContract[]	Seznam neplatných polí se odešle v žádosti v případě chyby ověření.
message	string	Znázornění chyby čitelné pro člověka

OperationResultContract

Výsledky dlouhotrvající operace Gitu

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku. Příklad – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Název prostředku
properties.actionLog	OperationResultLogItemContract[]	Tato vlastnost je poskytována pouze jako součást operace TenantConfiguration_Validate. Obsahuje protokol entit, které budou aktualizovány, vytvořeny nebo odstraněny v rámci operace TenantConfiguration_Deploy.
properties.error	ErrorResponseBody	Kontrakt textu chyby
properties.id	string	Identifikátor výsledku operace.
properties.resultInfo	string	Volitelné informace o výsledku.
properties.started	string	Čas zahájení asynchronní operace. Datum odpovídá následujícímu formátu: yyyy-MM-ddTHH:mm:ssZ podle normy ISO 8601.
properties.status	AsyncOperationStatus	Stav asynchronní operace.
properties.updated	string	Čas poslední aktualizace asynchronní operace. Datum odpovídá následujícímu formátu: yyyy-MM-ddTHH:mm:ssZ podle normy ISO 8601.
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

OperationResultLogItemContract

Protokol vytvářené, aktualizované nebo odstraněné entity

Name	Typ	Description
action	string	Akce, jako je vytvoření, aktualizace nebo odstranění
objectKey	string	Identifikátor vytvářené, aktualizované nebo odstraněné entity.
objectType	string	Typ kontraktu entity.