Credential Operations - Create Or Update

Service:

Data Factory

API Version:

2018-06-01

Creates or updates a credential.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/credentials/{credentialName}?api-version=2018-06-01

URI Parameters

Name	In	Required	Type	Description
credentialName	path	True	string minLength: 1 maxLength: 127 pattern: ^([_A-Za-z0-9]|([_A-Za-z0-9][-_A-Za-z0-9]{0,125}[_A-Za-z0-9]))$	Credential name
factoryName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	The factory name.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+$	The resource group name.
subscriptionId	path	True	string	The subscription identifier.
api-version	query	True	string	The API version.

Request Header

Name	Required	Type	Description
If-Match		string	ETag of the credential entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.

Request Body

Name	Required	Type	Description
properties	True	Credential: ServicePrincipalCredential ManagedIdentityCredential	Properties of credentials.

Responses

Name	Type	Description
200 OK	CredentialResource	OK.
Other Status Codes	CloudError	An error response received from PUT credential operation.

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

Credentials_Create

Sample request

HTTP

PUT https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/credentials/exampleCredential?api-version=2018-06-01

{
  "properties": {
    "type": "ManagedIdentity",
    "typeProperties": {
      "resourceId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourcegroups/exampleResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/exampleUami"
    }
  }
}

Java

import com.azure.resourcemanager.datafactory.models.ManagedIdentityCredential;

/**
 * Samples for CredentialOperations CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Credentials_Create.
     * json
     */
    /**
     * Sample code: Credentials_Create.
     * 
     * @param manager Entry point to DataFactoryManager.
     */
    public static void credentialsCreate(com.azure.resourcemanager.datafactory.DataFactoryManager manager) {
        manager.credentialOperations().define("exampleCredential")
            .withExistingFactory("exampleResourceGroup", "exampleFactoryName")
            .withProperties(new ManagedIdentityCredential().withResourceId(
                "/subscriptions/12345678-1234-1234-1234-12345678abc/resourcegroups/exampleResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/exampleUami"))
            .create();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.datafactory import DataFactoryManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-datafactory
# USAGE
    python credentials_create.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 = DataFactoryManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="12345678-1234-1234-1234-12345678abc",
    )

    response = client.credential_operations.create_or_update(
        resource_group_name="exampleResourceGroup",
        factory_name="exampleFactoryName",
        credential_name="exampleCredential",
        credential={
            "properties": {
                "type": "ManagedIdentity",
                "typeProperties": {
                    "resourceId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourcegroups/exampleResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/exampleUami"
                },
            }
        },
    )
    print(response)


# x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Credentials_Create.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 armdatafactory_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/datafactory/armdatafactory/v10"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/8eb3f7a4f66d408152c32b9d647e59147172d533/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Credentials_Create.json
func ExampleCredentialOperationsClient_CreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatafactory.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewCredentialOperationsClient().CreateOrUpdate(ctx, "exampleResourceGroup", "exampleFactoryName", "exampleCredential", armdatafactory.CredentialResource{
		Properties: &armdatafactory.ManagedIdentityCredential{
			Type: to.Ptr("ManagedIdentity"),
			TypeProperties: &armdatafactory.ManagedIdentityTypeProperties{
				ResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-12345678abc/resourcegroups/exampleResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/exampleUami"),
			},
		},
	}, &armdatafactory.CredentialOperationsClientCreateOrUpdateOptions{IfMatch: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %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.CredentialResource = armdatafactory.CredentialResource{
	// 	Name: to.Ptr("exampleCredential"),
	// 	Type: to.Ptr("Microsoft.DataFactory/factories/credentials"),
	// 	Etag: to.Ptr("0a0062d4-0000-0000-0000-5b245bcf0000"),
	// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/credentials/exampleCredential"),
	// 	Properties: &armdatafactory.ManagedIdentityCredential{
	// 		Type: to.Ptr("ManagedIdentity"),
	// 		TypeProperties: &armdatafactory.ManagedIdentityTypeProperties{
	// 			ResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-12345678abc/resourcegroups/exampleResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/exampleUami"),
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { DataFactoryManagementClient } = require("@azure/arm-datafactory");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates or updates a credential.
 *
 * @summary Creates or updates a credential.
 * x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Credentials_Create.json
 */
async function credentialsCreate() {
  const subscriptionId =
    process.env["DATAFACTORY_SUBSCRIPTION_ID"] || "12345678-1234-1234-1234-12345678abc";
  const resourceGroupName = process.env["DATAFACTORY_RESOURCE_GROUP"] || "exampleResourceGroup";
  const factoryName = "exampleFactoryName";
  const credentialName = "exampleCredential";
  const credentials = {
    properties: {
      type: "ManagedIdentity",
      resourceId:
        "/subscriptions/12345678-1234-1234-1234-12345678abc/resourcegroups/exampleResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/exampleUami",
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new DataFactoryManagementClient(credential, subscriptionId);
  const result = await client.credentialOperations.createOrUpdate(
    resourceGroupName,
    factoryName,
    credentialName,
    credentials,
  );
  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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.DataFactory.Models;
using Azure.ResourceManager.DataFactory;

// Generated from example definition: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Credentials_Create.json
// this example is just showing the usage of "CredentialOperations_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this DataFactoryServiceCredentialResource created on azure
// for more information of creating DataFactoryServiceCredentialResource, please refer to the document of DataFactoryServiceCredentialResource
string subscriptionId = "12345678-1234-1234-1234-12345678abc";
string resourceGroupName = "exampleResourceGroup";
string factoryName = "exampleFactoryName";
string credentialName = "exampleCredential";
ResourceIdentifier dataFactoryServiceCredentialResourceId = DataFactoryServiceCredentialResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, factoryName, credentialName);
DataFactoryServiceCredentialResource dataFactoryServiceCredential = client.GetDataFactoryServiceCredentialResource(dataFactoryServiceCredentialResourceId);

// invoke the operation
DataFactoryServiceCredentialData data = new DataFactoryServiceCredentialData(new DataFactoryManagedIdentityCredentialProperties
{
    ResourceId = new ResourceIdentifier("/subscriptions/12345678-1234-1234-1234-12345678abc/resourcegroups/exampleResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/exampleUami"),
});
ArmOperation<DataFactoryServiceCredentialResource> lro = await dataFactoryServiceCredential.UpdateAsync(WaitUntil.Completed, data);
DataFactoryServiceCredentialResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
DataFactoryServiceCredentialData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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:

200

Date: Sat, 16 Jun 2018 00:37:34 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-writes: 1196
x-ms-request-id: b3b336b3-b203-4654-9cb6-a3a8d3a4b5de
x-ms-correlation-request-id: b3b336b3-b203-4654-9cb6-a3a8d3a4b5de

{
  "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/credentials/exampleCredential",
  "name": "exampleCredential",
  "type": "Microsoft.DataFactory/factories/credentials",
  "properties": {
    "type": "ManagedIdentity",
    "typeProperties": {
      "resourceId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourcegroups/exampleResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/exampleUami"
    }
  },
  "etag": "0a0062d4-0000-0000-0000-5b245bcf0000"
}

Definitions

Name	Description
AzureKeyVaultSecretReference	Azure Key Vault secret reference.
CloudError	The object that defines the structure of an Azure Data Factory error response.
CredentialResource	Credential resource type.
LinkedServiceReference	Linked service reference type.
ManagedIdentityCredential	Managed identity credential.
ServicePrincipalCredential	Service principal credential.
Type	Linked service reference type.

AzureKeyVaultSecretReference

Object

Azure Key Vault secret reference.

Name	Type	Description
secretName	object	The name of the secret in Azure Key Vault. Type: string (or Expression with resultType string).
secretVersion	object	The version of the secret in Azure Key Vault. The default value is the latest version of the secret. Type: string (or Expression with resultType string).
store	LinkedServiceReference	The Azure Key Vault linked service reference.
type	string: AzureKeyVaultSecret	Type of the secret.

CloudError

Object

The object that defines the structure of an Azure Data Factory error response.

Name	Type	Description
error.code	string	Error code.
error.details	CloudError[]	Array with additional error details.
error.message	string	Error message.
error.target	string	Property name/path in request associated with error.

CredentialResource

Object

Credential resource type.

Name	Type	Description
etag	string	Etag identifies change in the resource.
id	string	The resource identifier.
name	string	The resource name.
properties	Credential: ManagedIdentityCredential ServicePrincipalCredential	Properties of credentials.
type	string	The resource type.

LinkedServiceReference

Object

Linked service reference type.

Name	Type	Description
parameters	object	Arguments for LinkedService.
referenceName	string	Reference LinkedService name.
type	Type	Linked service reference type.

ManagedIdentityCredential

Object

Managed identity credential.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Credential.
description	string	Credential description.
type	string: ManagedIdentity	Type of credential.
typeProperties.resourceId	string	The resource id of user assigned managed identity

ServicePrincipalCredential

Object

Service principal credential.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the Credential.
description	string	Credential description.
type	string: ServicePrincipal	Type of credential.
typeProperties.servicePrincipalId	object	The app ID of the service principal used to authenticate
typeProperties.servicePrincipalKey	AzureKeyVaultSecretReference	The key of the service principal used to authenticate.
typeProperties.tenant	object	The ID of the tenant to which the service principal belongs

Type

Enumeration

Linked service reference type.

Value	Description
LinkedServiceReference