Config Servers - Update Put

Service:

Azure Spring Apps

API Version:

2023-12-01

Update the config server.

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

URI Parameters

Name	In	Required	Type	Description
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	The name of the Service resource. Regex pattern: ^[a-z][a-z0-9-]*[a-z0-9]$
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	The API version to use for this operation.

Request Body

Name	Type	Description
properties	ConfigServerProperties	Properties of the Config Server resource

Responses

Name	Type	Description
200 OK	ConfigServerResource	Success. The response describes the updated Config Server.
202 Accepted	ConfigServerResource	Accepted. The response indicates the exiting Config Server is now updating and contains a Location header to query the operation result.
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

ConfigServers_UpdatePut

Sample Request

HTTP

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

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

Java

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

/**
 * Samples for ConfigServers UpdatePut.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/
     * ConfigServers_UpdatePut.json
     */
    /**
     * Sample code: ConfigServers_UpdatePut.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void configServersUpdatePut(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.springServices().manager().serviceClient().getConfigServers().updatePut("myResourceGroup", "myservice",
            new ConfigServerResourceInner().withProperties(
                new ConfigServerProperties().withConfigServer(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_update_put.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_update_put(
        resource_group_name="myResourceGroup",
        service_name="myservice",
        config_server_resource={
            "properties": {
                "configServer": {
                    "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_UpdatePut.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_UpdatePut.json
func ExampleConfigServersClient_BeginUpdatePut() {
	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().BeginUpdatePut(ctx, "myResourceGroup", "myservice", armappplatform.ConfigServerResource{
		Properties: &armappplatform.ConfigServerProperties{
			ConfigServer: &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.ConfigServerResource = armappplatform.ConfigServerResource{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/configServers"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/configServers/default"),
	// 	SystemData: &armappplatform.SystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
	// 		CreatedBy: to.Ptr("sample-user"),
	// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
	// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
	// 		LastModifiedBy: to.Ptr("sample-user"),
	// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
	// 	},
	// 	Properties: &armappplatform.ConfigServerProperties{
	// 		ConfigServer: &armappplatform.ConfigServerSettings{
	// 			GitProperty: &armappplatform.ConfigServerGitProperty{
	// 				Label: to.Ptr("master"),
	// 				SearchPaths: []*string{
	// 					to.Ptr("/")},
	// 					URI: to.Ptr("https://github.com/fake-user/fake-repository.git"),
	// 				},
	// 			},
	// 			ProvisioningState: to.Ptr(armappplatform.ConfigServerStateSucceeded),
	// 		},
	// 	}
}

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 Update the config server.
 *
 * @summary Update the config server.
 * x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ConfigServers_UpdatePut.json
 */
async function configServersUpdatePut() {
  const subscriptionId =
    process.env["APPPLATFORM_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["APPPLATFORM_RESOURCE_GROUP"] || "myResourceGroup";
  const serviceName = "myservice";
  const configServerResource = {
    properties: {
      configServer: {
        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.beginUpdatePutAndWait(
    resourceGroupName,
    serviceName,
    configServerResource,
  );
  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

{
  "properties": {
    "provisioningState": "Updating",
    "configServer": {
      "gitProperty": {
        "uri": "https://github.com/fake-user/fake-repository.git",
        "label": "master",
        "searchPaths": [
          "/"
        ]
      }
    }
  },
  "systemData": {
    "createdBy": "sample-user",
    "createdByType": "User",
    "createdAt": "2021-08-11T03:16:03.944Z",
    "lastModifiedBy": "sample-user",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-08-11T03:17:03.944Z"
  },
  "type": "Microsoft.AppPlatform/Spring/configServers",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/configServers/default",
  "name": "default"
}

Status code:

200

{
  "properties": {
    "provisioningState": "Succeeded",
    "configServer": {
      "gitProperty": {
        "uri": "https://github.com/fake-user/fake-repository.git",
        "label": "master",
        "searchPaths": [
          "/"
        ]
      }
    }
  },
  "systemData": {
    "createdBy": "sample-user",
    "createdByType": "User",
    "createdAt": "2021-08-11T03:16:03.944Z",
    "lastModifiedBy": "sample-user",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-08-11T03:17:03.944Z"
  },
  "type": "Microsoft.AppPlatform/Spring/configServers",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/configServers/default",
  "name": "default"
}

Definitions

Name	Description
CloudError	An error response from the service.
CloudErrorBody	An error response from the service.
ConfigServerGitProperty	Property of git.
ConfigServerProperties	Config server git properties payload
ConfigServerResource	Config Server resource
ConfigServerSettings	The settings of config server.
ConfigServerState	State of the config server.
createdByType	The type of identity that created the resource.
Error	The error code compose of code and message.
GitPatternRepository	Git repository property payload for config server
lastModifiedByType	The type of identity that last modified the resource.
SystemData	Metadata pertaining to creation and last modification of the resource.

CloudError

An error response from the service.

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

CloudErrorBody

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.

ConfigServerGitProperty

Property of git.

Name	Type	Description
hostKey	string	Public sshKey of git repository.
hostKeyAlgorithm	string	SshKey algorithm of git repository.
label	string	Label of the repository
password	string	Password of git repository basic auth.
privateKey	string	Private sshKey algorithm of git repository.
repositories	GitPatternRepository[]	Repositories of git.
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.

ConfigServerProperties

Config server git properties payload

Name	Type	Description
configServer	ConfigServerSettings	Settings of config server.
error	Error	Error when apply config server settings.
provisioningState	ConfigServerState	State of the config server.

ConfigServerResource

Config Server resource

Name	Type	Description
id	string	Fully qualified resource Id for the resource.
name	string	The name of the resource.
properties	ConfigServerProperties	Properties of the Config Server resource
systemData	SystemData	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource.

ConfigServerSettings

The settings of config server.

Name	Type	Description
gitProperty	ConfigServerGitProperty	Property of git environment.

ConfigServerState

State of the config server.

Name	Type	Description
Deleted	string
Failed	string
NotAvailable	string
Succeeded	string
Updating	string

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Error

The error code compose of code and message.

Name	Type	Description
code	string	The code of error.
message	string	The message of error.

GitPatternRepository

Git repository property payload for config server

Name	Type	Description
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.
pattern	string[]	Collection of pattern 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.

lastModifiedByType

The type of identity that last modified the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

SystemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	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	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.