Targets - Create Or Update

Služba:: Database Watcher

Verze rozhraní API:: 2025-01-02

Vytvoření cíle

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DatabaseWatcher/watchers/{watcherName}/targets/{targetName}?api-version=2025-01-02

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
subscriptionId	path	True	string (uuid)	ID cílového předplatného. Hodnota musí být UUID.
targetName	path	True	string pattern: ^[a-zA-Z0-9]{1}[a-zA-Z0-9-_]{3,60}$	Název cílového prostředku.
watcherName	path	True	string pattern: ^[a-zA-Z0-9]{1}[a-zA-Z0-9-_]{3,60}$	Název sledovacího nástroje databáze.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Typ	Description
properties	TargetProperties: SqlDbElasticPoolTargetProperties SqlDbSingleDatabaseTargetProperties SqlMiTargetProperties	Vlastnosti specifické pro prostředek pro tento prostředek.

Odpovědi

Name	Typ	Description
200 OK	Target	Operace aktualizace Cíle prostředku proběhla úspěšně.
201 Created	Target	Operace vytvoření cíle prostředku proběhla úspěšně.
Other Status Codes	ErrorResponse	Neočekávaná chybová odpověď

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Targets_CreateOrUpdate_MaximumSet

Ukázkový požadavek

PUT https://management.azure.com/subscriptions/49e0fbd3-75e8-44e7-96fd-5b64d9ad818d/resourceGroups/apiTest-ddat4p/providers/Microsoft.DatabaseWatcher/watchers/databasemo3ej9ih/targets/monitoringh22eed?api-version=2025-01-02

{
  "properties": {
    "targetType": "SqlDb",
    "targetAuthenticationType": "Aad",
    "connectionServerName": "sqlServero1ihe2",
    "sqlDbResourceId": "/subscriptions/49e0fbd3-75e8-44e7-96fd-5b64d9ad818d/resourceGroups/apiTest-ddat4p/providers/Microsoft.Sql/servers/m1/databases/m2"
  }
}


import com.azure.resourcemanager.databasewatcher.models.SqlDbSingleDatabaseTargetProperties;
import com.azure.resourcemanager.databasewatcher.models.TargetAuthenticationType;

/**
 * Samples for Targets CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-01-02/Targets_CreateOrUpdate_MaximumSet_Gen.json
     */
    /**
     * Sample code: Targets_CreateOrUpdate_MaximumSet.
     * 
     * @param manager Entry point to DatabaseWatcherManager.
     */
    public static void
        targetsCreateOrUpdateMaximumSet(com.azure.resourcemanager.databasewatcher.DatabaseWatcherManager manager) {
        manager.targets().define("monitoringh22eed").withExistingWatcher("apiTest-ddat4p", "databasemo3ej9ih")
            .withProperties(new SqlDbSingleDatabaseTargetProperties()
                .withTargetAuthenticationType(TargetAuthenticationType.AAD).withConnectionServerName("sqlServero1ihe2")
                .withSqlDbResourceId(
                    "/subscriptions/49e0fbd3-75e8-44e7-96fd-5b64d9ad818d/resourceGroups/apiTest-ddat4p/providers/Microsoft.Sql/servers/m1/databases/m2"))
            .create();
    }
}

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.databasewatcher import DatabaseWatcherMgmtClient

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

    response = client.targets.create_or_update(
        resource_group_name="apiTest-ddat4p",
        watcher_name="databasemo3ej9ih",
        target_name="monitoringh22eed",
        resource={
            "properties": {
                "connectionServerName": "sqlServero1ihe2",
                "sqlDbResourceId": "/subscriptions/49e0fbd3-75e8-44e7-96fd-5b64d9ad818d/resourceGroups/apiTest-ddat4p/providers/Microsoft.Sql/servers/m1/databases/m2",
                "targetAuthenticationType": "Aad",
                "targetType": "SqlDb",
            }
        },
    )
    print(response)


# x-ms-original-file: 2025-01-02/Targets_CreateOrUpdate_MaximumSet_Gen.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

package armdatabasewatcher_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/databasewatcher/armdatabasewatcher"
)

// Generated from example definition: 2025-01-02/Targets_CreateOrUpdate_MaximumSet_Gen.json
func ExampleTargetsClient_CreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatabasewatcher.NewClientFactory("49e0fbd3-75e8-44e7-96fd-5b64d9ad818d", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewTargetsClient().CreateOrUpdate(ctx, "apiTest-ddat4p", "databasemo3ej9ih", "monitoringh22eed", armdatabasewatcher.Target{
		Properties: &armdatabasewatcher.SQLDbSingleDatabaseTargetProperties{
			TargetType:               to.Ptr("SqlDb"),
			TargetAuthenticationType: to.Ptr(armdatabasewatcher.TargetAuthenticationTypeAAD),
			ConnectionServerName:     to.Ptr("sqlServero1ihe2"),
			SQLDbResourceID:          to.Ptr("/subscriptions/49e0fbd3-75e8-44e7-96fd-5b64d9ad818d/resourceGroups/apiTest-ddat4p/providers/Microsoft.Sql/servers/m1/databases/m2"),
		},
	}, 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 = armdatabasewatcher.TargetsClientCreateOrUpdateResponse{
	// 	Target: &armdatabasewatcher.Target{
	// 		Properties: &armdatabasewatcher.SQLDbSingleDatabaseTargetProperties{
	// 			TargetType: to.Ptr("SqlDb"),
	// 			TargetAuthenticationType: to.Ptr(armdatabasewatcher.TargetAuthenticationTypeAAD),
	// 			ConnectionServerName: to.Ptr("sqlServero1ihe2"),
	// 			SQLDbResourceID: to.Ptr("/subscriptions/49e0fbd3-75e8-44e7-96fd-5b64d9ad818d/resourceGroups/apiTest-ddat4p/providers/Microsoft.Sql/servers/m1/databases/m2"),
	// 			ProvisioningState: to.Ptr(armdatabasewatcher.ResourceProvisioningStateSucceeded),
	// 		},
	// 		ID: to.Ptr("/subscriptions/49e0fbd3-75e8-44e7-96fd-5b64d9ad818d/resourceGroups/apiTest-px9ma7/providers/Microsoft.DatabaseWatcher/watchers/databasemo3d9sgt/targets/monitoringzkndgm"),
	// 		Name: to.Ptr("monitoringzkndgm"),
	// 		Type: to.Ptr("microsoft.databasewatcher/watchers/targets"),
	// 		SystemData: &armdatabasewatcher.SystemData{
	// 			CreatedBy: to.Ptr("enbpvlpqbwd"),
	// 			CreatedByType: to.Ptr(armdatabasewatcher.CreatedByTypeUser),
	// 			CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2024-07-25T15:38:47.092Z"); return t}()),
	// 			LastModifiedBy: to.Ptr("mxp"),
	// 			LastModifiedByType: to.Ptr(armdatabasewatcher.CreatedByTypeUser),
	// 			LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2024-07-25T15:38:47.092Z"); return t}()),
	// 		},
	// 	},
	// }
}

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

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

/**
 * This sample demonstrates how to create a Target
 *
 * @summary create a Target
 * x-ms-original-file: 2025-01-02/Targets_CreateOrUpdate_MaximumSet_Gen.json
 */
async function targetsCreateOrUpdateMaximumSet() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "49e0fbd3-75e8-44e7-96fd-5b64d9ad818d";
  const client = new DatabaseWatcherClient(credential, subscriptionId);
  const result = await client.targets.createOrUpdate(
    "apiTest-ddat4p",
    "databasemo3ej9ih",
    "monitoringh22eed",
    {
      properties: {
        targetType: "SqlDb",
        targetAuthenticationType: "Aad",
        connectionServerName: "sqlServero1ihe2",
        sqlDbResourceId:
          "/subscriptions/49e0fbd3-75e8-44e7-96fd-5b64d9ad818d/resourceGroups/apiTest-ddat4p/providers/Microsoft.Sql/servers/m1/databases/m2",
      },
    },
  );
  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

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

// Generated from example definition: 2025-01-02/Targets_CreateOrUpdate_MaximumSet_Gen.json
// this example is just showing the usage of "Target_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 DatabaseWatcherTargetResource created on azure
// for more information of creating DatabaseWatcherTargetResource, please refer to the document of DatabaseWatcherTargetResource
string subscriptionId = "49e0fbd3-75e8-44e7-96fd-5b64d9ad818d";
string resourceGroupName = "apiTest-ddat4p";
string watcherName = "databasemo3ej9ih";
string targetName = "monitoringh22eed";
ResourceIdentifier databaseWatcherTargetResourceId = DatabaseWatcherTargetResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, watcherName, targetName);
DatabaseWatcherTargetResource databaseWatcherTarget = client.GetDatabaseWatcherTargetResource(databaseWatcherTargetResourceId);

// invoke the operation
DatabaseWatcherTargetData data = new DatabaseWatcherTargetData
{
    Properties = new SqlDBSingleDatabaseTargetProperties(TargetAuthenticationType.Aad, "sqlServero1ihe2", new ResourceIdentifier("/subscriptions/49e0fbd3-75e8-44e7-96fd-5b64d9ad818d/resourceGroups/apiTest-ddat4p/providers/Microsoft.Sql/servers/m1/databases/m2")),
};
ArmOperation<DatabaseWatcherTargetResource> lro = await databaseWatcherTarget.UpdateAsync(WaitUntil.Completed, data);
DatabaseWatcherTargetResource 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
DatabaseWatcherTargetData 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

Ukázková odpověď

Stavový kód:: 200

{
  "properties": {
    "targetType": "SqlDb",
    "targetAuthenticationType": "Aad",
    "connectionServerName": "sqlServero1ihe2",
    "sqlDbResourceId": "/subscriptions/49e0fbd3-75e8-44e7-96fd-5b64d9ad818d/resourceGroups/apiTest-ddat4p/providers/Microsoft.Sql/servers/m1/databases/m2",
    "provisioningState": "Succeeded"
  },
  "id": "/subscriptions/49e0fbd3-75e8-44e7-96fd-5b64d9ad818d/resourceGroups/apiTest-px9ma7/providers/Microsoft.DatabaseWatcher/watchers/databasemo3d9sgt/targets/monitoringzkndgm",
  "name": "monitoringzkndgm",
  "type": "microsoft.databasewatcher/watchers/targets",
  "systemData": {
    "createdBy": "enbpvlpqbwd",
    "createdByType": "User",
    "createdAt": "2024-07-25T15:38:47.092Z",
    "lastModifiedBy": "mxp",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-07-25T15:38:47.092Z"
  }
}

Stavový kód:: 201

{
  "properties": {
    "targetType": "SqlDb",
    "targetAuthenticationType": "Aad",
    "connectionServerName": "sqlServero1ihe2",
    "sqlDbResourceId": "/subscriptions/49e0fbd3-75e8-44e7-96fd-5b64d9ad818d/resourceGroups/apiTest-ddat4p/providers/Microsoft.Sql/servers/m1/databases/m2",
    "provisioningState": "Succeeded"
  },
  "id": "/subscriptions/49e0fbd3-75e8-44e7-96fd-5b64d9ad818d/resourceGroups/apiTest-px9ma7/providers/Microsoft.DatabaseWatcher/watchers/databasemo3d9sgt/targets/monitoringzkndgm",
  "name": "monitoringzkndgm",
  "type": "microsoft.databasewatcher/watchers/targets",
  "systemData": {
    "createdBy": "enbpvlpqbwd",
    "createdByType": "User",
    "createdAt": "2024-07-25T15:38:47.092Z",
    "lastModifiedBy": "mxp",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-07-25T15:38:47.092Z"
  }
}

Definice

Name	Description
createdByType	Typ identity, která prostředek vytvořila.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
ResourceProvisioningState	Stav zřizování prostředku pravidla upozornění.
SqlDbElasticPoolTargetProperties	Vlastnosti specifické pro elastický fond v Azure SQL Database.
SqlDbSingleDatabaseTargetProperties	Vlastnosti specifické pro databázi v Azure SQL Database.
SqlMiTargetProperties	Vlastnosti specifické pro cíle Azure SQL Managed Instance.
systemData	Metadata týkající se vytvoření a poslední změny prostředku.
Target	Konkrétní typy prostředků proxy můžou být vytvořeny aliasem tohoto typu pomocí konkrétního typu vlastnosti.
TargetAuthenticationType	Typ ověřování, který se má použít při připojování k cíli.
VaultSecret	Konkrétní podrobnosti trezoru se vyžadují, pokud se pro připojení k cíli používá ověřování SQL.

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

ResourceProvisioningState

Výčet

Stav zřizování prostředku pravidla upozornění.

Hodnota	Description
Succeeded	Prostředek byl vytvořen.
Failed	Vytvoření prostředku se nezdařilo.
Canceled	Vytvoření prostředku bylo zrušeno.

SqlDbElasticPoolTargetProperties

Objekt

Vlastnosti specifické pro elastický fond v Azure SQL Database.

Name	Typ	Default value	Description
anchorDatabaseResourceId	string (arm-id)		ID prostředku Azure databáze ukotvení použité k připojení k elastickému fondu.
connectionServerName	string maxLength: 200		Název hostitele plně kvalifikovaného názvu domény serveru, který se má použít v připojovacím řetězci při připojování k cíli. Například pro logický server Azure SQL v komerčním cloudu Azure může být hodnota sql-logical-server-22092780.database.windows.net; pro spravovanou instanci Azure SQL v komerčním cloudu Azure může být hodnota sql-mi-39441134.767d5869f605.database.windows.net. Číslo portu a název instance musí být zadány samostatně.
provisioningState	ResourceProvisioningState		Stav zřizování prostředku.
readIntent	boolean	False	Pokud existuje, nastavte hodnotu true pro monitorování repliky s vysokou dostupností zadaného cíle.
sqlEpResourceId	string (arm-id)		ID prostředku Azure cíle elastického fondu Azure SQL DB.
targetAuthenticationType	TargetAuthenticationType		Typ ověřování, který se má použít při připojování k cíli.
targetType	string: SqlEp		Diskriminující vlastnost pro TargetProperties.
targetVault	VaultSecret		Pokud chcete při připojování k cílům použít ověřování SQL, zadejte trezor, ve kterém jsou uložené přihlašovací jméno a tajné kódy hesel.

SqlDbSingleDatabaseTargetProperties

Objekt

Vlastnosti specifické pro databázi v Azure SQL Database.

Name	Typ	Default value	Description
connectionServerName	string maxLength: 200		Název hostitele plně kvalifikovaného názvu domény serveru, který se má použít v připojovacím řetězci při připojování k cíli. Například pro logický server Azure SQL v komerčním cloudu Azure může být hodnota sql-logical-server-22092780.database.windows.net; pro spravovanou instanci Azure SQL v komerčním cloudu Azure může být hodnota sql-mi-39441134.767d5869f605.database.windows.net. Číslo portu a název instance musí být zadány samostatně.
provisioningState	ResourceProvisioningState		Stav zřizování prostředku.
readIntent	boolean	False	Pokud existuje, nastavte hodnotu true pro monitorování repliky s vysokou dostupností zadaného cíle.
sqlDbResourceId	string (arm-id)		ID prostředku Azure cílové databáze Azure SQL Db.
targetAuthenticationType	TargetAuthenticationType		Typ ověřování, který se má použít při připojování k cíli.
targetType	string: SqlDb		Diskriminující vlastnost pro TargetProperties.
targetVault	VaultSecret		Pokud chcete při připojování k cílům použít ověřování SQL, zadejte trezor, ve kterém jsou uložené přihlašovací jméno a tajné kódy hesel.

SqlMiTargetProperties

Objekt

Vlastnosti specifické pro cíle Azure SQL Managed Instance.

Name	Typ	Default value	Description
connectionServerName	string maxLength: 200		Název hostitele plně kvalifikovaného názvu domény serveru, který se má použít v připojovacím řetězci při připojování k cíli. Například pro logický server Azure SQL v komerčním cloudu Azure může být hodnota sql-logical-server-22092780.database.windows.net; pro spravovanou instanci Azure SQL v komerčním cloudu Azure může být hodnota sql-mi-39441134.767d5869f605.database.windows.net. Číslo portu a název instance musí být zadány samostatně.
connectionTcpPort	integer (int32)	1433	Číslo portu TCP, které se má volitelně použít v připojovacím řetězci při připojování k cíli služby Azure SQL Managed Instance.
provisioningState	ResourceProvisioningState		Stav zřizování prostředku.
readIntent	boolean	False	Pokud existuje, nastavte hodnotu true pro monitorování repliky s vysokou dostupností zadaného cíle.
sqlMiResourceId	string (arm-id)		ID prostředku Azure cíle služby Azure SQL Managed Instance.
targetAuthenticationType	TargetAuthenticationType		Typ ověřování, který se má použít při připojování k cíli.
targetType	string: SqlMi		Diskriminující vlastnost pro TargetProperties.
targetVault	VaultSecret		Pokud chcete při připojování k cílům použít ověřování SQL, zadejte trezor, ve kterém jsou uložené přihlašovací jméno a tajné kódy hesel.

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

Target

Objekt

Konkrétní typy prostředků proxy můžou být vytvořeny aliasem tohoto typu pomocí konkrétního typu vlastnosti.

Name	Typ	Description
id	string (arm-id)	Plně kvalifikované ID prostředku pro prostředek. Například /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Název prostředku
properties	TargetProperties: SqlDbElasticPoolTargetProperties SqlDbSingleDatabaseTargetProperties SqlMiTargetProperties	Vlastnosti specifické pro prostředek pro tento prostředek.
systemData	systemData	Metadata Azure Resource Manageru obsahující informace createdBy a modifiedBy
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

TargetAuthenticationType

Výčet

Typ ověřování, který se má použít při připojování k cíli.

Hodnota	Description
Aad	Ověřování Azure Active Directory.
Sql	Ověřování heslem SQL.

VaultSecret

Objekt

Konkrétní podrobnosti trezoru se vyžadují, pokud se pro připojení k cíli používá ověřování SQL.

Name	Typ	Description
akvResourceId	string (arm-id)	ID prostředku Azure instance služby Key Vault, do které se ukládají tajné kódy ověřování databáze.
akvTargetPassword	string pattern: ^[a-zA-Z0-9-]{1,127}$	Cesta k tajnému klíči služby Key Vault, do které se ukládá heslo pro ověření do cíle.
akvTargetUser	string pattern: ^[a-zA-Z0-9-]{1,127}$	Cesta k tajnému klíči služby Key Vault, do které se ukládá přihlašovací jméno (neboli uživatelské jméno neboli název účtu) pro ověření do cíle.