Configuration Services - Validate Resource

Service:: Azure Spring Apps

API Version:: 2023-12-01

Check if the Application Configuration Service resource is valid.

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

URI Parameters

Name	In	Required	Type	Description
configurationServiceName	path	True	string pattern: ^[a-z][a-z0-9]*$	The name of Application Configuration Service.
resourceGroupName	path	True	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName	path	True	string pattern: ^[a-z][a-z0-9-]*[a-z0-9]$	The name of the Service resource.
subscriptionId	path	True	string	Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Type	Description
properties	ConfigurationServiceProperties	Application Configuration Service properties payload

Responses

Name	Type	Description
200 OK	ConfigurationServiceSettingsValidateResult	Success. The response describes the validation result of Application Configuration Service.
202 Accepted		Accepted. The response indicates the ConfigurationServiceSettings is validating. Headers Location: string
Other Status Codes	CloudError	Error response describing why the operation failed.

Name

Type

Description

200 OK

ConfigurationServiceSettingsValidateResult

Success. The response describes the validation result of Application Configuration Service.

202 Accepted

Accepted. The response indicates the ConfigurationServiceSettings is validating.

Headers

Location: string

Other Status Codes

CloudError

Error response describing why the operation failed.

Security

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	impersonate your user account

Examples

ConfigurationServices_ValidateResource

Sample request

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

{
  "properties": {
    "settings": {
      "gitProperty": {
        "repositories": [
          {
            "name": "fake",
            "uri": "https://github.com/fake-user/fake-repository",
            "patterns": [
              "app/dev"
            ],
            "label": "master"
          }
        ]
      }
    }
  }
}


import com.azure.resourcemanager.appplatform.fluent.models.ConfigurationServiceResourceInner;
import com.azure.resourcemanager.appplatform.models.ConfigurationServiceGitProperty;
import com.azure.resourcemanager.appplatform.models.ConfigurationServiceGitRepository;
import com.azure.resourcemanager.appplatform.models.ConfigurationServiceProperties;
import com.azure.resourcemanager.appplatform.models.ConfigurationServiceSettings;
import java.util.Arrays;

/**
 * Samples for ConfigurationServices ValidateResource.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/
     * ConfigurationServices_ValidateResource.json
     */
    /**
     * Sample code: ConfigurationServices_ValidateResource.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void configurationServicesValidateResource(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.springServices().manager().serviceClient().getConfigurationServices()
            .validateResource("myResourceGroup", "myservice", "default", new ConfigurationServiceResourceInner()
                .withProperties(new ConfigurationServiceProperties().withSettings(new ConfigurationServiceSettings()
                    .withGitProperty(new ConfigurationServiceGitProperty().withRepositories(Arrays.asList(
                        new ConfigurationServiceGitRepository().withName("fake").withPatterns(Arrays.asList("app/dev"))
                            .withUri("https://github.com/fake-user/fake-repository").withLabel("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

from azure.identity import DefaultAzureCredential

from azure.mgmt.appplatform import AppPlatformManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-appplatform
# USAGE
    python configuration_services_validate_resource.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.configuration_services.begin_validate_resource(
        resource_group_name="myResourceGroup",
        service_name="myservice",
        configuration_service_name="default",
        configuration_service_resource={
            "properties": {
                "settings": {
                    "gitProperty": {
                        "repositories": [
                            {
                                "label": "master",
                                "name": "fake",
                                "patterns": ["app/dev"],
                                "uri": "https://github.com/fake-user/fake-repository",
                            }
                        ]
                    }
                }
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ConfigurationServices_ValidateResource.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

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/ConfigurationServices_ValidateResource.json
func ExampleConfigurationServicesClient_BeginValidateResource() {
	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.NewConfigurationServicesClient().BeginValidateResource(ctx, "myResourceGroup", "myservice", "default", armappplatform.ConfigurationServiceResource{
		Properties: &armappplatform.ConfigurationServiceProperties{
			Settings: &armappplatform.ConfigurationServiceSettings{
				GitProperty: &armappplatform.ConfigurationServiceGitProperty{
					Repositories: []*armappplatform.ConfigurationServiceGitRepository{
						{
							Name:  to.Ptr("fake"),
							Label: to.Ptr("master"),
							Patterns: []*string{
								to.Ptr("app/dev")},
							URI: to.Ptr("https://github.com/fake-user/fake-repository"),
						}},
				},
			},
		},
	}, 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.ConfigurationServiceSettingsValidateResult = armappplatform.ConfigurationServiceSettingsValidateResult{
	// 	GitPropertyValidationResult: &armappplatform.ConfigurationServiceGitPropertyValidateResult{
	// 		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

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

/**
 * This sample demonstrates how to Check if the Application Configuration Service resource is valid.
 *
 * @summary Check if the Application Configuration Service resource is valid.
 * x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ConfigurationServices_ValidateResource.json
 */
async function configurationServicesValidateResource() {
  const subscriptionId =
    process.env["APPPLATFORM_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["APPPLATFORM_RESOURCE_GROUP"] || "myResourceGroup";
  const serviceName = "myservice";
  const configurationServiceName = "default";
  const configurationServiceResource = {
    properties: {
      settings: {
        gitProperty: {
          repositories: [
            {
              name: "fake",
              label: "master",
              patterns: ["app/dev"],
              uri: "https://github.com/fake-user/fake-repository",
            },
          ],
        },
      },
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new AppPlatformManagementClient(credential, subscriptionId);
  const result = await client.configurationServices.beginValidateResourceAndWait(
    resourceGroupName,
    serviceName,
    configurationServiceName,
    configurationServiceResource,
  );
  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:: 200

{
  "gitPropertyValidationResult": {
    "isValid": true
  }
}

Status code:: 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

Definitions

Name	Description
CloudError	An error response from the service.
CloudErrorBody	An error response from the service.
ConfigurationServiceGeneration	The generation of the Application Configuration Service.
ConfigurationServiceGitProperty	Property of git environment.
ConfigurationServiceGitPropertyValidateResult	Validation result for configuration service settings
ConfigurationServiceGitRepository	Git repository property payload for Application Configuration Service
ConfigurationServiceInstance	Collection of instances belong to the Application Configuration Service
ConfigurationServiceProperties	Application Configuration Service properties payload
ConfigurationServiceProvisioningState	State of the Application Configuration Service.
ConfigurationServiceResource	Application Configuration Service resource
ConfigurationServiceResourceRequests	Resource request payload of Application Configuration Service
ConfigurationServiceSettings	The settings of Application Configuration Service.
ConfigurationServiceSettingsValidateResult	Validation result for configuration service settings
createdByType	The type of identity that created the resource.
GitImplementation	Git libraries used to support various repository providers
lastModifiedByType	The type of identity that last modified the resource.
SystemData	Metadata pertaining to creation and last modification of the resource.
ValidationMessages	Validate messages of the configuration service git repositories

CloudError

Object

An error response from the service.

Name	Type	Description
error	CloudErrorBody	An error response from the service.

CloudErrorBody

Object

An error response from the service.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details	CloudErrorBody[]	A list of additional details about the error.
message	string	A message describing the error, intended to be suitable for display in a user interface.
target	string	The target of the particular error. For example, the name of the property in error.

ConfigurationServiceGeneration

Enumeration

The generation of the Application Configuration Service.

Value	Description
Gen1
Gen2

ConfigurationServiceGitProperty

Object

Property of git environment.

Name	Type	Description
repositories	ConfigurationServiceGitRepository[]	Repositories of Application Configuration Service git property.

ConfigurationServiceGitPropertyValidateResult

Object

Validation result for configuration service settings

Name	Type	Description
gitReposValidationResult	ValidationMessages[]	The detail validation results
isValid	boolean	Indicate if the configuration service settings are valid

ConfigurationServiceGitRepository

Object

Git repository property payload for Application Configuration Service

Name	Type	Description
caCertResourceId	string	Resource Id of CA certificate for https URL of Git repository.
gitImplementation	GitImplementation	Git libraries used to support various repository providers
hostKey	string	Public sshKey of git repository.
hostKeyAlgorithm	string	SshKey algorithm of git repository.
label	string	Label of the repository
name	string	Name of the repository
password	string	Password of git repository basic auth.
patterns	string[]	Collection of patterns of the repository
privateKey	string	Private sshKey algorithm of git repository.
searchPaths	string[]	Searching path of the repository
strictHostKeyChecking	boolean	Strict host key checking or not.
uri	string	URI of the repository
username	string	Username of git repository basic auth.

ConfigurationServiceInstance

Object

Collection of instances belong to the Application Configuration Service

Name	Type	Description
name	string	Name of the Application Configuration Service instance
status	string	Status of the Application Configuration Service instance

ConfigurationServiceProperties

Object

Application Configuration Service properties payload

Name	Type	Default value	Description
generation	ConfigurationServiceGeneration	Gen1	The generation of the Application Configuration Service.
instances	ConfigurationServiceInstance[]		Collection of instances belong to Application Configuration Service.
provisioningState	ConfigurationServiceProvisioningState		State of the Application Configuration Service.
resourceRequests	ConfigurationServiceResourceRequests		The requested resource quantity for required CPU and Memory.
settings	ConfigurationServiceSettings		The settings of Application Configuration Service.

ConfigurationServiceProvisioningState

Enumeration

State of the Application Configuration Service.

Value	Description
Creating
Updating
Succeeded
Failed
Deleting

ConfigurationServiceResource

Object

Application Configuration Service resource

Name	Type	Description
id	string	Fully qualified resource Id for the resource.
name	string	The name of the resource.
properties	ConfigurationServiceProperties	Application Configuration Service properties payload
systemData	SystemData	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource.

ConfigurationServiceResourceRequests

Object

Resource request payload of Application Configuration Service

Name	Type	Description
cpu	string	Cpu allocated to each Application Configuration Service instance
instanceCount	integer (int32)	Instance count of the Application Configuration Service
memory	string	Memory allocated to each Application Configuration Service instance

ConfigurationServiceSettings

Object

The settings of Application Configuration Service.

Name	Type	Description
gitProperty	ConfigurationServiceGitProperty	Property of git environment.

ConfigurationServiceSettingsValidateResult

Object

Validation result for configuration service settings

Name	Type	Description
gitPropertyValidationResult	ConfigurationServiceGitPropertyValidateResult	Validation result for configuration service settings

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

GitImplementation

Enumeration

Git libraries used to support various repository providers

Value	Description
go-git
libgit2

lastModifiedByType

Enumeration

The type of identity that last modified the resource.

Value	Description
User
Application
ManagedIdentity
Key

SystemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource modification (UTC).
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	lastModifiedByType	The type of identity that last modified the resource.

ValidationMessages

Object

Validate messages of the configuration service git repositories

Name	Type	Description
messages	string[]	Detailed validation messages.
name	string	The name of the configuration service git repository.

Share via

Configuration Services - Validate Resource

URI Parameters

Request Body

Responses

Security

azure_auth

Scopes

Examples

ConfigurationServices_ValidateResource

Sample request

Sample response

Definitions

CloudError

CloudErrorBody

ConfigurationServiceGeneration

ConfigurationServiceGitProperty

ConfigurationServiceGitPropertyValidateResult

ConfigurationServiceGitRepository

ConfigurationServiceInstance

ConfigurationServiceProperties

ConfigurationServiceProvisioningState

ConfigurationServiceResource

ConfigurationServiceResourceRequests

ConfigurationServiceSettings

ConfigurationServiceSettingsValidateResult

createdByType

GitImplementation

lastModifiedByType

SystemData

ValidationMessages