Config Servers - Validate

Serviço:

Azure Spring Apps

Versão da API:

2023-12-01

Verifique se as configurações do servidor de configuração são válidas.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/configServers/validate?api-version=2023-12-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos que contém o recurso. Você pode obter esse valor na API do Azure Resource Manager ou no portal.
serviceName	path	True	string pattern: ^[a-z][a-z0-9-]*[a-z0-9]$	O nome do recurso de serviço.
subscriptionId	path	True	string	Obtém a ID da assinatura que identifica exclusivamente a assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Tipo	Description
gitProperty	ConfigServerGitProperty	Propriedade do ambiente git.

Respostas

Nome	Tipo	Description
200 OK	ConfigServerSettingsValidateResult	Êxito. A resposta descreve o resultado da validação do Servidor de Configuração.
202 Accepted	ConfigServerSettingsValidateResult	Aceitado. A resposta indica que ConfigServerSetting está validando.
Other Status Codes	CloudError	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

ConfigServers_Validate

Solicitação de exemplo

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/configServers/validate?api-version=2023-12-01

{
  "gitProperty": {
    "uri": "https://github.com/fake-user/fake-repository.git",
    "label": "master",
    "searchPaths": [
      "/"
    ]
  }
}

Java

import com.azure.resourcemanager.appplatform.models.ConfigServerGitProperty;
import com.azure.resourcemanager.appplatform.models.ConfigServerSettings;
import java.util.Arrays;

/**
 * Samples for ConfigServers Validate.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/
     * ConfigServers_Validate.json
     */
    /**
     * Sample code: ConfigServers_Validate.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void configServersValidate(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.springServices().manager().serviceClient().getConfigServers().validate("myResourceGroup", "myservice",
            new ConfigServerSettings().withGitProperty(
                new ConfigServerGitProperty().withUri("https://github.com/fake-user/fake-repository.git")
                    .withLabel("master").withSearchPaths(Arrays.asList("/"))),
            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 azure.identity import DefaultAzureCredential

from azure.mgmt.appplatform import AppPlatformManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-appplatform
# USAGE
    python config_servers_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 = AppPlatformManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.config_servers.begin_validate(
        resource_group_name="myResourceGroup",
        service_name="myservice",
        config_server_settings={
            "gitProperty": {
                "label": "master",
                "searchPaths": ["/"],
                "uri": "https://github.com/fake-user/fake-repository.git",
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ConfigServers_Validate.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 armappplatform_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/appplatform/armappplatform/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ConfigServers_Validate.json
func ExampleConfigServersClient_BeginValidate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewConfigServersClient().BeginValidate(ctx, "myResourceGroup", "myservice", armappplatform.ConfigServerSettings{
		GitProperty: &armappplatform.ConfigServerGitProperty{
			Label: to.Ptr("master"),
			SearchPaths: []*string{
				to.Ptr("/")},
			URI: to.Ptr("https://github.com/fake-user/fake-repository.git"),
		},
	}, 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.ConfigServerSettingsValidateResult = armappplatform.ConfigServerSettingsValidateResult{
	// 	IsValid: to.Ptr(true),
	// }
}

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 { AppPlatformManagementClient } = require("@azure/arm-appplatform");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Check if the config server settings are valid.
 *
 * @summary Check if the config server settings are valid.
 * x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ConfigServers_Validate.json
 */
async function configServersValidate() {
  const subscriptionId =
    process.env["APPPLATFORM_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["APPPLATFORM_RESOURCE_GROUP"] || "myResourceGroup";
  const serviceName = "myservice";
  const configServerSettings = {
    gitProperty: {
      label: "master",
      searchPaths: ["/"],
      uri: "https://github.com/fake-user/fake-repository.git",
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new AppPlatformManagementClient(credential, subscriptionId);
  const result = await client.configServers.beginValidateAndWait(
    resourceGroupName,
    serviceName,
    configServerSettings,
  );
  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

Resposta de exemplo

Código de status:

200

{
  "isValid": true
}

Código de status:

202

Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2023-12-01
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2023-12-01

{}

Definições

Nome	Description
CloudError	Uma resposta de erro do serviço.
CloudErrorBody	Uma resposta de erro do serviço.
ConfigServerGitProperty	Propriedade do git.
ConfigServerSettings	As configurações do servidor de configuração.
ConfigServerSettingsErrorRecord	Registro de erro das configurações do servidor de configuração
ConfigServerSettingsValidateResult	Resultado da validação para configurações do servidor de configuração
GitPatternRepository	Conteúdo da propriedade do repositório Git para o servidor de configuração

CloudError

Objeto

Uma resposta de erro do serviço.

Nome	Tipo	Description
error	CloudErrorBody	Uma resposta de erro do serviço.

CloudErrorBody

Objeto

Uma resposta de erro do serviço.

Nome	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariáveis e devem ser consumidos programaticamente.
details	CloudErrorBody[]	Uma lista de detalhes adicionais sobre o erro.
message	string	Uma mensagem que descreve o erro, destinada a ser adequada para exibição em uma interface do usuário.
target	string	O destino do erro específico. Por exemplo, o nome da propriedade em erro.

ConfigServerGitProperty

Objeto

Propriedade do git.

Nome	Tipo	Description
hostKey	string	SshKey público do repositório git.
hostKeyAlgorithm	string	Algoritmo SshKey do repositório git.
label	string	Rótulo do repositório
password	string	Senha da autenticação básica do repositório git.
privateKey	string	Algoritmo sshKey privado do repositório git.
repositories	GitPatternRepository[]	Repositórios do git.
searchPaths	string[]	Caminho de pesquisa do repositório
strictHostKeyChecking	boolean	Verificação estrita da chave de host ou não.
uri	string	URI do repositório
username	string	Nome de usuário da autenticação básica do repositório git.

ConfigServerSettings

Objeto

As configurações do servidor de configuração.

Nome	Tipo	Description
gitProperty	ConfigServerGitProperty	Propriedade do ambiente git.

ConfigServerSettingsErrorRecord

Objeto

Registro de erro das configurações do servidor de configuração

Nome	Tipo	Description
messages	string[]	As mensagens de erro de detalhes do registro
name	string	O nome do registro de erro de configurações do servidor de configuração
uri	string	O uri do registro de erro de configurações do servidor de configuração

ConfigServerSettingsValidateResult

Objeto

Resultado da validação para configurações do servidor de configuração

Nome	Tipo	Description
details	ConfigServerSettingsErrorRecord[]	Os resultados da validação detalhada
isValid	boolean	Indicar se as configurações do servidor de configuração são válidas

GitPatternRepository

Objeto

Conteúdo da propriedade do repositório Git para o servidor de configuração

Nome	Tipo	Description
hostKey	string	SshKey público do repositório git.
hostKeyAlgorithm	string	Algoritmo SshKey do repositório git.
label	string	Rótulo do repositório
name	string	Nome do repositório
password	string	Senha da autenticação básica do repositório git.
pattern	string[]	Coleção de padrão do repositório
privateKey	string	Algoritmo sshKey privado do repositório git.
searchPaths	string[]	Caminho de pesquisa do repositório
strictHostKeyChecking	boolean	Verificação estrita da chave de host ou não.
uri	string	URI do repositório
username	string	Nome de usuário da autenticação básica do repositório git.