Associations - Create Or Update

Hizmet:

Custom Providers

API Sürümü:

2018-09-01-preview

İlişkilendirme oluşturun veya güncelleştirin.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
associationName	path	True	string	İlişkilendirmenin adı.
scope	path	True	string	İlişkilendirmenin kapsamı. Kapsam geçerli herhangi bir REST kaynak örneği olabilir. Örneğin, bir sanal makine kaynağı için '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.Compute/virtualMachines/{vm-name}' kullanın.
api-version	query	True	string	HTTP isteğiyle kullanılacak API sürümü.

İstek Gövdesi

Name	Tür	Description
properties.targetResourceId	string	Bu ilişkilendirme için hedef kaynağın REST kaynak örneği.

Yanıtlar

Name	Tür	Description
200 OK	Association	Tamam ögesini seçin. İlişkilendirme zaten var ve değişiklikler kabul edildi.
201 Created	Association	Oluşturulan. İlişkilendirme oluşturuldu.
Other Status Codes	ErrorResponse	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

Create or update an association

Örnek isteği

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

Örnek yanıt

Durum kodu:

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

Durum kodu:

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

Tanımlar

Name	Description
Association	Bu ilişkilendirmenin kaynak tanımı.
ErrorDefinition	Hata tanımı.
ErrorResponse	Hata yanıtı.
ProvisioningState	Kaynak sağlayıcısının sağlama durumu.

Association

Bu ilişkilendirmenin kaynak tanımı.

Name	Tür	Description
id	string	İlişkilendirme kimliği.
name	string	İlişkilendirme adı.
properties.provisioningState	ProvisioningState	İlişkilendirmenin sağlama durumu.
properties.targetResourceId	string	Bu ilişkilendirme için hedef kaynağın REST kaynak örneği.
type	string	İlişkilendirme türü.

ErrorDefinition

Hata tanımı.

Name	Tür	Description
code	string	HTTP hata kodu için alt durum olarak hizmet veren hizmete özgü hata kodu.
details	ErrorDefinition[]	İç hata ayrıntıları.
message	string	Hatanın açıklaması.

ErrorResponse

Hata yanıtı.

Name	Tür	Description
error	ErrorDefinition	Hata ayrıntıları.

ProvisioningState

Kaynak sağlayıcısının sağlama durumu.

Name	Tür	Description
Accepted	string
Deleting	string
Failed	string
Running	string
Succeeded	string