Service Registries - Create Or Update

Service:: Azure Spring Apps

API Version:: 2023-12-01

Create the default Service Registry or update the existing Service Registry.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/serviceRegistries/{serviceRegistryName}?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 pattern: ^[a-z][a-z0-9-]*[a-z0-9]$	The name of the Service resource.
serviceRegistryName	path	True	string	The name of Service Registry.
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.

Responses

Name	Type	Description
200 OK	ServiceRegistryResource	Success. The response describes the updated Service Registry.
201 Created	ServiceRegistryResource	Created. The response describes the new created Service Registry and contains an Azure-AsyncOperation 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

ServiceRegistries_CreateOrUpdate

Sample request

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


/**
 * Samples for ServiceRegistries CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/
     * ServiceRegistries_CreateOrUpdate.json
     */
    /**
     * Sample code: ServiceRegistries_CreateOrUpdate.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void serviceRegistriesCreateOrUpdate(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.springServices().manager().serviceClient().getServiceRegistries().createOrUpdate("myResourceGroup",
            "myservice", "default", 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 service_registries_create_or_update.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.service_registries.begin_create_or_update(
        resource_group_name="myResourceGroup",
        service_name="myservice",
        service_registry_name="default",
    ).result()
    print(response)


# x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ServiceRegistries_CreateOrUpdate.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/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/ServiceRegistries_CreateOrUpdate.json
func ExampleServiceRegistriesClient_BeginCreateOrUpdate() {
	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.NewServiceRegistriesClient().BeginCreateOrUpdate(ctx, "myResourceGroup", "myservice", "default", 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.ServiceRegistryResource = armappplatform.ServiceRegistryResource{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/serviceRegistries"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/serviceRegistries/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.ServiceRegistryProperties{
	// 		Instances: []*armappplatform.ServiceRegistryInstance{
	// 			{
	// 				Name: to.Ptr("instance1"),
	// 				Status: to.Ptr("Running"),
	// 			},
	// 			{
	// 				Name: to.Ptr("instance2"),
	// 				Status: to.Ptr("Running"),
	// 		}},
	// 		ProvisioningState: to.Ptr(armappplatform.ServiceRegistryProvisioningStateSucceeded),
	// 		ResourceRequests: &armappplatform.ServiceRegistryResourceRequests{
	// 			CPU: to.Ptr("1"),
	// 			InstanceCount: to.Ptr[int32](2),
	// 			Memory: to.Ptr("1G"),
	// 		},
	// 	},
	// }
}

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 Create the default Service Registry or update the existing Service Registry.
 *
 * @summary Create the default Service Registry or update the existing Service Registry.
 * x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ServiceRegistries_CreateOrUpdate.json
 */
async function serviceRegistriesCreateOrUpdate() {
  const subscriptionId =
    process.env["APPPLATFORM_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["APPPLATFORM_RESOURCE_GROUP"] || "myResourceGroup";
  const serviceName = "myservice";
  const serviceRegistryName = "default";
  const credential = new DefaultAzureCredential();
  const client = new AppPlatformManagementClient(credential, subscriptionId);
  const result = await client.serviceRegistries.beginCreateOrUpdateAndWait(
    resourceGroupName,
    serviceName,
    serviceRegistryName,
  );
  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:: 201

{
  "properties": {
    "provisioningState": "Creating",
    "resourceRequests": {
      "cpu": "1",
      "memory": "1G",
      "instanceCount": 2
    },
    "instances": [
      {
        "name": "instance1",
        "status": "Running"
      },
      {
        "name": "instance2",
        "status": "Running"
      }
    ]
  },
  "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/serviceRegistries",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/serviceRegistries/default",
  "name": "default"
}

Status code:: 200

{
  "properties": {
    "provisioningState": "Succeeded",
    "resourceRequests": {
      "cpu": "1",
      "memory": "1G",
      "instanceCount": 2
    },
    "instances": [
      {
        "name": "instance1",
        "status": "Running"
      },
      {
        "name": "instance2",
        "status": "Running"
      }
    ]
  },
  "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/serviceRegistries",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/serviceRegistries/default",
  "name": "default"
}

Definitions

Name	Description
CloudError	An error response from the service.
CloudErrorBody	An error response from the service.
createdByType	The type of identity that created the resource.
lastModifiedByType	The type of identity that last modified the resource.
ServiceRegistryInstance	Collection of instances belong to the Service Registry
ServiceRegistryProperties	Service Registry properties payload
ServiceRegistryProvisioningState	State of the Service Registry.
ServiceRegistryResource	Service Registry resource
ServiceRegistryResourceRequests	Resource request payload of Service Registry
SystemData	Metadata pertaining to creation and last modification of the resource.

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.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

lastModifiedByType

Enumeration

The type of identity that last modified the resource.

Value	Description
User
Application
ManagedIdentity
Key

ServiceRegistryInstance

Object

Collection of instances belong to the Service Registry

Name	Type	Description
name	string	Name of the Service Registry instance
status	string	Status of the Service Registry instance

ServiceRegistryProperties

Object

Service Registry properties payload

Name	Type	Description
instances	ServiceRegistryInstance[]	Collection of instances belong to Service Registry.
provisioningState	ServiceRegistryProvisioningState	State of the Service Registry.
resourceRequests	ServiceRegistryResourceRequests	The requested resource quantity for required CPU and Memory.

ServiceRegistryProvisioningState

Enumeration

State of the Service Registry.

Value	Description
Creating
Updating
Succeeded
Failed
Deleting

ServiceRegistryResource

Object

Service Registry resource

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

ServiceRegistryResourceRequests

Object

Resource request payload of Service Registry

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

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.

Share via

Service Registries - Create Or Update

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

ServiceRegistries_CreateOrUpdate

Sample request

Sample response

Definitions

CloudError

CloudErrorBody

createdByType

lastModifiedByType

ServiceRegistryInstance

ServiceRegistryProperties

ServiceRegistryProvisioningState

ServiceRegistryResource

ServiceRegistryResourceRequests

SystemData