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

Associations - Create Or Update

Service:

Custom Providers

API Version:

2018-09-01-preview

创建或更新关联。

PUT https://management.azure.com/{scope}/providers/Microsoft.CustomProviders/associations/{associationName}?api-version=2018-09-01-preview

URI 参数

名称	在	必需	类型	说明
associationName	path	True	string	关联的名称。
scope	path	True	string	关联的范围。 范围可以是任何有效的 REST 资源实例。 例如，对虚拟机资源使用“/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.Compute/virtualMachines/{vm-name}”。
api-version	query	True	string	要与 HTTP 请求一起使用的 API 版本。

请求正文

名称	类型	说明
properties.targetResourceId	string	此关联的目标资源的 REST 资源实例。

响应

名称	类型	说明
200 OK	Association	没问题。 关联已存在，并且已接受更改。
201 Created	Association	Created. 已创建关联。
Other Status Codes	ErrorResponse	描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

Create or update an association

Sample Request

HTTP

PUT https://management.azure.com/scope/providers/Microsoft.CustomProviders/associations/associationName?api-version=2018-09-01-preview

{
  "properties": {
    "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/appRG/providers/Microsoft.Solutions/applications/applicationName"
  }
}

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.customproviders import Customproviders

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-customproviders
# USAGE
    python create_or_update_an_association.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 = Customproviders(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.associations.begin_create_or_update(
        scope="scope",
        association_name="associationName",
        association={
            "properties": {
                "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/appRG/providers/Microsoft.Solutions/applications/applicationName"
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/customproviders/resource-manager/Microsoft.CustomProviders/preview/2018-09-01-preview/examples/createOrUpdateAssociation.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 armcustomproviders_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/customproviders/armcustomproviders"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/customproviders/resource-manager/Microsoft.CustomProviders/preview/2018-09-01-preview/examples/createOrUpdateAssociation.json
func ExampleAssociationsClient_BeginCreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomproviders.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewAssociationsClient().BeginCreateOrUpdate(ctx, "scope", "associationName", armcustomproviders.Association{
		Properties: &armcustomproviders.AssociationProperties{
			TargetResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/appRG/providers/Microsoft.Solutions/applications/applicationName"),
		},
	}, 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.Association = armcustomproviders.Association{
	// 	Name: to.Ptr("associationName"),
	// 	Type: to.Ptr("Microsoft.CustomProviders/associations"),
	// 	ID: to.Ptr("/scope/providers/Microsoft.CustomProviders/associations/associationName"),
	// 	Properties: &armcustomproviders.AssociationProperties{
	// 		ProvisioningState: to.Ptr(armcustomproviders.ProvisioningStateSucceeded),
	// 		TargetResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/appRG/providers/Microsoft.Solutions/applications/applicationName"),
	// 	},
	// }
}

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

{
  "name": "associationName",
  "id": "/scope/providers/Microsoft.CustomProviders/associations/associationName",
  "type": "Microsoft.CustomProviders/associations",
  "properties": {
    "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/appRG/providers/Microsoft.Solutions/applications/applicationName",
    "provisioningState": "Accepted"
  }
}

Status code:

200

{
  "name": "associationName",
  "id": "/scope/providers/Microsoft.CustomProviders/associations/associationName",
  "type": "Microsoft.CustomProviders/associations",
  "properties": {
    "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/appRG/providers/Microsoft.Solutions/applications/applicationName",
    "provisioningState": "Succeeded"
  }
}

定义

名称	说明
Association	此关联的资源定义。
ErrorDefinition	错误定义。
ErrorResponse	错误响应。
ProvisioningState	资源提供程序的预配状态。

Association

此关联的资源定义。

名称	类型	说明
id	string	关联 ID。
name	string	关联名称。
properties.provisioningState	ProvisioningState	关联的预配状态。
properties.targetResourceId	string	此关联的目标资源的 REST 资源实例。
type	string	关联类型。

ErrorDefinition

错误定义。

名称	类型	说明
code	string	服务特定的错误代码，用作 HTTP 错误代码的子状态。
details	ErrorDefinition[]	内部错误详细信息。
message	string	错误的说明。

ErrorResponse

错误响应。

名称	类型	说明
error	ErrorDefinition	错误详细信息。

ProvisioningState

资源提供程序的预配状态。

名称	类型	说明
Accepted	string
Deleting	string
Failed	string
Running	string
Succeeded	string