Connector - Create Dryrun

Service:

Service Connector

API Version:

2022-11-01-preview

create a dryrun job to do necessary check before actual creation

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceLinker/locations/{location}/dryruns/{dryrunName}?api-version=2022-11-01-preview

URI Parameters

Name	In	Required	Type	Description
dryrunName	path	True	string	The name of dryrun.
location	path	True	string minLength: 1	The name of Azure region.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Type	Description
properties.parameters	DryrunParameters: CreateOrUpdateDryrunParameters	The parameters of the dryrun

Responses

Name	Type	Description
200 OK	DryrunResource	OK. The request has succeeded.
201 Created	DryrunResource	Long running operation
Other Status Codes	ErrorResponse	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

ConnectorDryrunCreate

Sample request

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ServiceLinker/locations/westus/dryruns/dryrunName?api-version=2022-11-01-preview

{
  "properties": {
    "parameters": {
      "actionName": "createOrUpdate",
      "targetService": {
        "type": "AzureResource",
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db"
      },
      "authInfo": {
        "authType": "secret",
        "name": "name",
        "secretInfo": {
          "secretType": "rawValue",
          "value": "secret"
        }
      }
    }
  }
}

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.servicelinker import ServiceLinkerManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-servicelinker
# USAGE
    python connector_dryrun_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 = ServiceLinkerManagementClient(
        credential=DefaultAzureCredential(),
    )

    response = client.connector.begin_create_dryrun(
        subscription_id="00000000-0000-0000-0000-000000000000",
        resource_group_name="test-rg",
        location="westus",
        dryrun_name="dryrunName",
        parameters={
            "properties": {
                "parameters": {
                    "actionName": "createOrUpdate",
                    "authInfo": {
                        "authType": "secret",
                        "name": "name",
                        "secretInfo": {"secretType": "rawValue", "value": "secret"},
                    },
                    "targetService": {
                        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db",
                        "type": "AzureResource",
                    },
                }
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2022-11-01-preview/examples/ConnectorDryrunCreate.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

Sample response

Status code:

200

{
  "name": "dryrunName",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ServiceLinker/locations/westus/dryruns/dryrunName",
  "properties": {
    "parameters": {
      "actionName": "createOrUpdate",
      "targetService": {
        "type": "AzureResource",
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db"
      },
      "authInfo": {
        "authType": "secret",
        "name": "name"
      }
    },
    "prerequisiteResults": [
      {
        "type": "basicError",
        "code": "ResourceNotFound",
        "message": "Target resource is not found"
      },
      {
        "type": "permissionsMissing",
        "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc",
        "permissions": [
          "Microsoft.DocumentDb/databaseAccounts/write"
        ]
      }
    ],
    "operationPreviews": [
      {
        "name": "configFirewallRule",
        "operationType": "configNetwork",
        "description": "Config firewall rule for target service to allow source service access",
        "action": "Microsoft.DocumentDb/databaseAccounts/write",
        "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc"
      }
    ],
    "provisioningState": "Succeeded"
  }
}

Status code:

201

{
  "name": "dryrunName",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ServiceLinker/locations/westus/dryruns/dryrunName",
  "properties": {
    "parameters": {
      "actionName": "createOrUpdate",
      "targetService": {
        "type": "AzureResource",
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db"
      },
      "authInfo": {
        "authType": "secret",
        "name": "name"
      }
    },
    "prerequisiteResults": [
      {
        "type": "basicError",
        "code": "ResourceNotFound",
        "message": "Target resource is not found"
      },
      {
        "type": "permissionsMissing",
        "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc",
        "permissions": [
          "Microsoft.DocumentDb/databaseAccounts/write"
        ]
      }
    ],
    "operationPreviews": [
      {
        "name": "configFirewallRule",
        "operationType": "configNetwork",
        "description": "Config firewall rule for target service to allow source service access",
        "action": "Microsoft.DocumentDb/databaseAccounts/write",
        "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc"
      }
    ],
    "provisioningState": "Accepted"
  }
}

Definitions

Name	Description
AccessKeyInfoBase	The access key directly from target resource properties, which target service is Azure Resource, such as Microsoft.Storage
accessKeyPermissions	Permissions of the accessKey. Read and Write are for Azure Cosmos DB and Azure App Configuration, Listen, Send and Manage are for Azure Event Hub and Azure Service Bus.
actionType	Optional. Indicates public network solution. If enable, enable public network access of target service with best try. Default is enable. If optOut, opt out public network access configuration.
allowType	Allow Azure services to access the target service if true.
AuthType	The authentication type.
AzureKeyVaultProperties	The resource properties when type is Azure Key Vault
AzureResource	The azure resource info when target service type is AzureResource
BasicErrorDryrunPrerequisiteResult	The represent of basic error
clientType	The application client type
ConfigurationInfo	The configuration information, used to generate configurations or save to applications
ConfluentBootstrapServer	The service properties when target service type is ConfluentBootstrapServer
ConfluentSchemaRegistry	The service properties when target service type is ConfluentSchemaRegistry
createdByType	The type of identity that created the resource.
CreateOrUpdateDryrunParameters	The dryrun parameters for creation or update a linker
DaprMetadata	The dapr component metadata.
DaprProperties	Indicates some additional properties for dapr client type
DeleteOrUpdateBehavior	The cleanup behavior to indicate whether clean up operation when resource is deleted or updated
DryrunActionName	The name of action for you dryrun job.
DryrunOperationPreview	The preview of the operations for creation
DryrunPrerequisiteResultType	The type of dryrun result.
DryrunPreviewOperationType	The operation type
DryrunResource	a dryrun job resource
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
FirewallRules	Target service's firewall rules. to allow connections from source service.
KeyVaultSecretReferenceSecretInfo	The secret info when type is keyVaultSecretReference. It's for scenario that user provides a secret stored in user's keyvault and source is Azure Kubernetes. The key Vault's resource id is linked to secretStore.keyVaultId.
KeyVaultSecretUriSecretInfo	The secret info when type is keyVaultSecretUri. It's for scenario that user provides a secret stored in user's keyvault and source is Web App, Spring Cloud or Container App.
PermissionsMissingDryrunPrerequisiteResult	The represent of missing permissions
PublicNetworkSolution	Indicates public network solution, include firewall rules
SecretAuthInfo	The authentication info when authType is secret
SecretStore	An option to store secret value in secure place
SecretType	The secret type.
SelfHostedServer	The service properties when target service type is SelfHostedServer
ServicePrincipalCertificateAuthInfo	The authentication info when authType is servicePrincipal certificate
ServicePrincipalSecretAuthInfo	The authentication info when authType is servicePrincipal secret
SystemAssignedIdentityAuthInfo	The authentication info when authType is systemAssignedIdentity
systemData	Metadata pertaining to creation and last modification of the resource.
UserAccountAuthInfo	The authentication info when authType is user account
UserAssignedIdentityAuthInfo	The authentication info when authType is userAssignedIdentity
ValueSecretInfo	The secret info when type is rawValue. It's for scenarios that user input the secret.
VNetSolution	The VNet solution for linker
vNetSolutionType	Type of VNet solution.

AccessKeyInfoBase

Object

The access key directly from target resource properties, which target service is Azure Resource, such as Microsoft.Storage

Name	Type	Description
authType	string: accessKey	The authentication type.
permissions	accessKeyPermissions[]	Permissions of the accessKey. Read and Write are for Azure Cosmos DB and Azure App Configuration, Listen, Send and Manage are for Azure Event Hub and Azure Service Bus.

accessKeyPermissions

Enumeration

Permissions of the accessKey. Read and Write are for Azure Cosmos DB and Azure App Configuration, Listen, Send and Manage are for Azure Event Hub and Azure Service Bus.

Value	Description
Read
Write
Listen
Send
Manage

actionType

Enumeration

Optional. Indicates public network solution. If enable, enable public network access of target service with best try. Default is enable. If optOut, opt out public network access configuration.

Value	Description
enable
optOut

allowType

Enumeration

Allow Azure services to access the target service if true.

Value	Description
true
false

AuthType

Enumeration

The authentication type.

Value	Description
systemAssignedIdentity
userAssignedIdentity
servicePrincipalSecret
servicePrincipalCertificate
secret
accessKey
userAccount

AzureKeyVaultProperties

Object

The resource properties when type is Azure Key Vault

Name	Type	Description
connectAsKubernetesCsiDriver	boolean	True if connect via Kubernetes CSI Driver.
type	string: KeyVault	The azure resource type.

AzureResource

Object

The azure resource info when target service type is AzureResource

Name	Type	Description
id	string	The Id of azure resource.
resourceProperties	AzureResourcePropertiesBase: AzureKeyVaultProperties	The azure resource connection related properties.
type	string: AzureResource	The target service type.

BasicErrorDryrunPrerequisiteResult

Object

The represent of basic error

Name	Type	Description
code	string	The error code.
message	string	The error message.
type	string: basicError	The type of dryrun result.

clientType

Enumeration

The application client type

Value	Description
none
dotnet
java
python
go
php
ruby
django
nodejs
springBoot
kafka-springBoot
dapr

ConfigurationInfo

Object

The configuration information, used to generate configurations or save to applications

Name	Type	Description
action	actionType	Optional, indicate whether to apply configurations on source application. If enable, generate configurations and applied to the source application. Default is enable. If optOut, no configuration change will be made on source.
additionalConfigurations	object	A dictionary of additional configurations to be added. Service will auto generate a set of basic configurations and this property is to full fill more customized configurations
customizedKeys	object	Optional. A dictionary of default key name and customized key name mapping. If not specified, default key name will be used for generate configurations
daprProperties	DaprProperties	Indicates some additional properties for dapr client type
deleteOrUpdateBehavior	DeleteOrUpdateBehavior	Indicates whether to clean up previous operation when Linker is updating or deleting

ConfluentBootstrapServer

Object

The service properties when target service type is ConfluentBootstrapServer

Name	Type	Description
endpoint	string	The endpoint of service.
type	string: ConfluentBootstrapServer	The target service type.

ConfluentSchemaRegistry

Object

The service properties when target service type is ConfluentSchemaRegistry

Name	Type	Description
endpoint	string	The endpoint of service.
type	string: ConfluentSchemaRegistry	The target service type.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

CreateOrUpdateDryrunParameters

Object

The dryrun parameters for creation or update a linker

Name	Type	Description
actionName	string: createOrUpdate	The name of action for you dryrun job.
authInfo	AuthInfoBase: AccessKeyInfoBase SecretAuthInfo ServicePrincipalCertificateAuthInfo ServicePrincipalSecretAuthInfo SystemAssignedIdentityAuthInfo UserAccountAuthInfo UserAssignedIdentityAuthInfo	The authentication type.
clientType	clientType	The application client type
configurationInfo	ConfigurationInfo	The connection information consumed by applications, including secrets, connection strings.
provisioningState	string	The provisioning state.
publicNetworkSolution	PublicNetworkSolution	The network solution.
scope	string	connection scope in source service.
secretStore	SecretStore	An option to store secret value in secure place
targetService	TargetServiceBase: AzureResource ConfluentBootstrapServer ConfluentSchemaRegistry SelfHostedServer	The target service properties
vNetSolution	VNetSolution	The VNet solution.

DaprMetadata

Object

The dapr component metadata.

Name	Type	Description
name	string	Metadata property name.
secretRef	string	The secret name where dapr could get value
value	string	Metadata property value.

DaprProperties

Object

Indicates some additional properties for dapr client type

Name	Type	Description
componentType	string	The dapr component type
metadata	DaprMetadata[]	Additional dapr metadata
scopes	string[]	The dapr component scopes
secretStoreComponent	string	The name of a secret store dapr to retrieve secret
version	string	The dapr component version

DeleteOrUpdateBehavior

Enumeration

The cleanup behavior to indicate whether clean up operation when resource is deleted or updated

Value	Description
Default
ForcedCleanup

DryrunActionName

Enumeration

The name of action for you dryrun job.

Value	Description
createOrUpdate

DryrunOperationPreview

Object

The preview of the operations for creation

Name	Type	Description
action	string	The action defined by RBAC, refer https://docs.microsoft.com/azure/role-based-access-control/role-definitions#actions-format
description	string	The description of the operation
name	string	The operation name
operationType	DryrunPreviewOperationType	The operation type
scope	string	The scope of the operation, refer https://docs.microsoft.com/azure/role-based-access-control/scope-overview

DryrunPrerequisiteResultType

Enumeration

The type of dryrun result.

Value	Description
basicError
permissionsMissing

DryrunPreviewOperationType

Enumeration

The operation type

Value	Description
configConnection
configNetwork
configAuth

DryrunResource

Object

a dryrun job resource

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties.operationPreviews	DryrunOperationPreview[]	the preview of the operations for creation
properties.parameters	DryrunParameters: CreateOrUpdateDryrunParameters	The parameters of the dryrun
properties.prerequisiteResults	DryrunPrerequisiteResult[]: BasicErrorDryrunPrerequisiteResult[] PermissionsMissingDryrunPrerequisiteResult[]	the result of the dryrun
properties.provisioningState	string	The provisioning state.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

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

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

FirewallRules

Object

Target service's firewall rules. to allow connections from source service.

Name	Type	Description
azureServices	allowType	Allow Azure services to access the target service if true.
callerClientIP	allowType	Allow caller client IP to access the target service if true. the property is used when connecting local application to target service.
ipRanges	string[]	This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IPs for a given database account.

KeyVaultSecretReferenceSecretInfo

Object

The secret info when type is keyVaultSecretReference. It's for scenario that user provides a secret stored in user's keyvault and source is Azure Kubernetes. The key Vault's resource id is linked to secretStore.keyVaultId.

Name	Type	Description
name	string	Name of the Key Vault secret.
secretType	string: keyVaultSecretReference	The secret type.
version	string	Version of the Key Vault secret.

KeyVaultSecretUriSecretInfo

Object

The secret info when type is keyVaultSecretUri. It's for scenario that user provides a secret stored in user's keyvault and source is Web App, Spring Cloud or Container App.

Name	Type	Description
secretType	string: keyVaultSecretUri	The secret type.
value	string	URI to the keyvault secret

PermissionsMissingDryrunPrerequisiteResult

Object

The represent of missing permissions

Name	Type	Description
permissions	string[]	The permission list
recommendedRole	string	The recommended role to resolve permissions missing
scope	string	The permission scope
type	string: permissionsMissing	The type of dryrun result.

PublicNetworkSolution

Object

Indicates public network solution, include firewall rules

Name	Type	Description
action	actionType	Optional. Indicates public network solution. If enable, enable public network access of target service with best try. Default is enable. If optOut, opt out public network access configuration.
deleteOrUpdateBehavior	DeleteOrUpdateBehavior	Indicates whether to clean up previous operation(such as firewall rules) when Linker is updating or deleting
firewallRules	FirewallRules	Describe firewall rules of target service to make sure source application could connect to the target.

SecretAuthInfo

Object

The authentication info when authType is secret

Name	Type	Description
authType	string: secret	The authentication type.
name	string	Username or account name for secret auth.
secretInfo	SecretInfoBase: KeyVaultSecretReferenceSecretInfo KeyVaultSecretUriSecretInfo ValueSecretInfo	Password or key vault secret for secret auth.

SecretStore

Object

An option to store secret value in secure place

Name	Type	Description
keyVaultId	string	The key vault id to store secret
keyVaultSecretName	string	The key vault secret name to store secret, only valid when storing one secret

SecretType

Enumeration

The secret type.

Value	Description
rawValue
keyVaultSecretUri
keyVaultSecretReference

SelfHostedServer

Object

The service properties when target service type is SelfHostedServer

Name	Type	Description
endpoint	string	The endpoint of service.
type	string: SelfHostedServer	The target service type.

ServicePrincipalCertificateAuthInfo

Object

The authentication info when authType is servicePrincipal certificate

Name	Type	Description
authType	string: servicePrincipalCertificate	The authentication type.
certificate	string	ServicePrincipal certificate for servicePrincipal auth.
clientId	string	Application clientId for servicePrincipal auth.
deleteOrUpdateBehavior	DeleteOrUpdateBehavior	Indicates whether to clean up previous operation when Linker is updating or deleting
principalId	string	Principal Id for servicePrincipal auth.
roles	string[]	Optional, this value specifies the Azure roles to be assigned. Automatically

ServicePrincipalSecretAuthInfo

Object

The authentication info when authType is servicePrincipal secret

Name	Type	Description
authType	string: servicePrincipalSecret	The authentication type.
clientId	string	ServicePrincipal application clientId for servicePrincipal auth.
deleteOrUpdateBehavior	DeleteOrUpdateBehavior	Indicates whether to clean up previous operation when Linker is updating or deleting
principalId	string	Principal Id for servicePrincipal auth.
roles	string[]	Optional, this value specifies the Azure roles to be assigned. Automatically
secret	string	Secret for servicePrincipal auth.
userName	string	Username created in the database which is mapped to a user in AAD.

SystemAssignedIdentityAuthInfo

Object

The authentication info when authType is systemAssignedIdentity

Name	Type	Description
authType	string: systemAssignedIdentity	The authentication type.
deleteOrUpdateBehavior	DeleteOrUpdateBehavior	Indicates whether to clean up previous operation when Linker is updating or deleting
roles	string[]	Optional, this value specifies the Azure role to be assigned
userName	string	Username created in the database which is mapped to a user in AAD.

systemData

Object

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 last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

UserAccountAuthInfo

Object

The authentication info when authType is user account

Name	Type	Description
authType	string: userAccount	The authentication type.
deleteOrUpdateBehavior	DeleteOrUpdateBehavior	Indicates whether to clean up previous operation when Linker is updating or deleting
principalId	string	Principal Id for user account.
roles	string[]	Optional, this value specifies the Azure roles to be assigned. Automatically
userName	string	Username created in the database which is mapped to a user in AAD.

UserAssignedIdentityAuthInfo

Object

The authentication info when authType is userAssignedIdentity

Name	Type	Description
authType	string: userAssignedIdentity	The authentication type.
clientId	string	Client Id for userAssignedIdentity.
deleteOrUpdateBehavior	DeleteOrUpdateBehavior	Indicates whether to clean up previous operation when Linker is updating or deleting
roles	string[]	Optional, this value specifies the Azure role to be assigned
subscriptionId	string	Subscription id for userAssignedIdentity.
userName	string	Username created in the database which is mapped to a user in AAD.

ValueSecretInfo

Object

The secret info when type is rawValue. It's for scenarios that user input the secret.

Name	Type	Description
secretType	string: rawValue	The secret type.
value	string	The actual value of the secret.

VNetSolution

Object

The VNet solution for linker

Name	Type	Description
deleteOrUpdateBehavior	DeleteOrUpdateBehavior	Indicates whether to clean up previous operation when Linker is updating or deleting
type	vNetSolutionType	Type of VNet solution.

vNetSolutionType

Enumeration

Type of VNet solution.

Value	Description
serviceEndpoint
privateLink