你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Builders - Update

Update a BuilderResource

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/builders/{builderName}?api-version=2024-02-02-preview

URI Parameters

Name In Required Type Description
builderName
path True

string

The name of the builder.

Regex pattern: ^[-\w\._\(\)]+$

resourceGroupName
path True

string

The name of the resource group. The name is case insensitive.

subscriptionId
path True

string

uuid

The ID of the target subscription. The value must be an UUID.

api-version
query True

string

The API version to use for this operation.

Request Body

Name Type Description
identity

ManagedServiceIdentity

The managed service identities assigned to this resource.

properties.environmentId

string

Resource ID of the container apps environment that the builder is associated with.

tags

object

Resource tags.

Responses

Name Type Description
200 OK

BuilderResource

ARM operation completed successfully.

202 Accepted

Resource update request accepted.

Headers

Location: string

Other Status Codes

ErrorResponse

Common error response.

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

Builders_Update_0

Sample request

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.App/builders/testBuilder?api-version=2024-02-02-preview

{
  "tags": {
    "mytag1": "myvalue1"
  }
}

Sample response

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/builders/testBuilder",
  "name": "testBuilder",
  "type": "Microsoft.App/builders",
  "location": "eastus",
  "identity": {
    "type": "SystemAssigned,UserAssigned",
    "principalId": "00000000-0000-0000-0000-000000000000",
    "tenantId": "00000000-0000-0000-0000-000000000000",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {
        "clientId": "00000000-0000-0000-0000-000000000000",
        "principalId": "00000000-0000-0000-0000-000000000000"
      }
    }
  },
  "properties": {
    "provisioningState": "Succeeded",
    "environmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/managedEnvironments/testEnv",
    "containerRegistries": [
      {
        "containerRegistryServer": "test.azurecr.io",
        "identityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1"
      },
      {
        "containerRegistryServer": "test2.azurecr.io",
        "identityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1"
      }
    ]
  },
  "systemData": {
    "createdBy": "sample@microsoft.com",
    "createdByType": "User",
    "createdAt": "2022-10-11T11:05:51.4940669Z",
    "lastModifiedBy": "sample@microsoft.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2022-10-11T11:05:51.4940669Z"
  },
  "tags": {
    "mytag1": "myvalue1"
  }
}
Location: https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.App/locations/{location}/operationStatuses/{operationId}

Definitions

Name Description
BuilderProvisioningState

Resource instance provisioning state.

BuilderResource

Information about the SourceToCloud builder resource.

BuilderResourceUpdate

The type used for update operations of the BuilderResource.

ContainerRegistry

Model representing a mapping from a container registry to the identity used to connect to it.

createdByType

The type of identity that created the resource.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

ManagedServiceIdentity

Managed service identity (system assigned and/or user assigned identities)

ManagedServiceIdentityType

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

systemData

Metadata pertaining to creation and last modification of the resource.

UserAssignedIdentity

User assigned identity properties

BuilderProvisioningState

Resource instance provisioning state.

Name Type Description
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

BuilderResource

Information about the SourceToCloud builder resource.

Name Type Description
id

string

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

identity

ManagedServiceIdentity

The managed service identities assigned to this resource.

location

string

The geo-location where the resource lives

name

string

The name of the resource

properties.containerRegistries

ContainerRegistry[]

List of mappings of container registries and the managed identity used to connect to it.

properties.environmentId

string

Resource ID of the container apps environment that the builder is associated with.

properties.provisioningState

BuilderProvisioningState

Provisioning state of a builder resource.

systemData

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

tags

object

Resource tags.

type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

BuilderResourceUpdate

The type used for update operations of the BuilderResource.

Name Type Description
identity

ManagedServiceIdentity

The managed service identities assigned to this resource.

properties.environmentId

string

Resource ID of the container apps environment that the builder is associated with.

tags

object

Resource tags.

ContainerRegistry

Model representing a mapping from a container registry to the identity used to connect to it.

Name Type Description
containerRegistryServer

string

Login server of the container registry.

identityResourceId

string

Resource ID of the managed identity.

createdByType

The type of identity that created the resource.

Name Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.

code

string

The error code.

details

ErrorDetail[]

The error details.

message

string

The error message.

target

string

The error target.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.

ManagedServiceIdentity

Managed service identity (system assigned and/or user assigned identities)

Name Type Description
principalId

string

The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.

tenantId

string

The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.

type

ManagedServiceIdentityType

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

userAssignedIdentities

<string,  UserAssignedIdentity>

User-Assigned Identities
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

ManagedServiceIdentityType

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

Name Type Description
None

string

SystemAssigned

string

SystemAssigned,UserAssigned

string

UserAssigned

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 last modification (UTC)

lastModifiedBy

string

The identity that last modified the resource.

lastModifiedByType

createdByType

The type of identity that last modified the resource.

UserAssignedIdentity

User assigned identity properties

Name Type Description
clientId

string

The client ID of the assigned identity.

principalId

string

The principal ID of the assigned identity.