Share via


Service Registries - Create Or Update

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

Sample response

{
  "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"
}
{
  "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

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.

createdByType

The type of identity that created the resource.

Value Description
User
Application
ManagedIdentity
Key

lastModifiedByType

The type of identity that last modified the resource.

Value Description
User
Application
ManagedIdentity
Key

ServiceRegistryInstance

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

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

State of the Service Registry.

Value Description
Creating
Updating
Succeeded
Failed
Deleting

ServiceRegistryResource

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

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

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.