Sql Collector Operations - Create

Service:: Azure Migrate

Version d'API:: 2024-01-15

Créer un SqlCollector

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlcollectors/{collectorName}?api-version=2024-01-15

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
collectorName	path	True	string pattern: ^[^<>&:\?/#]{1,260}$	Nom ARM du collecteur Sql.
projectName	path	True	string pattern: ^[^<>&:\?/#]{1,260}$	Nom du projet d’évaluation
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Type	Description
properties.agentProperties	CollectorAgentPropertiesBase	Obtient ou définit les propriétés de l’agent collecteur.
properties.discoverySiteId	string	Obtient l’ID de site de découverte.
properties.provisioningState	ProvisioningState	État de la dernière opération.

Réponses

Nom	Type	Description
200 OK	SqlCollector	Opération de mise à jour « SqlCollector » de ressource réussie
201 Created	SqlCollector	Opération de création de ressource « SqlCollector » réussie En-têtes Retry-After: integer
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

Nom

Type

Description

200 OK

SqlCollector

Opération de mise à jour « SqlCollector » de ressource réussie

201 Created

SqlCollector

Opération de création de ressource « SqlCollector » réussie

En-têtes

Retry-After: integer

Other Status Codes

ErrorResponse

Réponse d’erreur inattendue.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

SqlCollectorOperations_Create_MaximumSet_Gen

Exemple de requête

HTTP

PUT https://management.azure.com/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/rgmigrate/providers/Microsoft.Migrate/assessmentProjects/fci-test6904project/sqlcollectors/fci-test0c1esqlsitecollector?api-version=2024-01-15

{
  "properties": {
    "agentProperties": {
      "id": "630da710-4d44-41f7-a189-72fe3db5502b-agent",
      "version": null,
      "lastHeartbeatUtc": null,
      "spnDetails": {
        "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47",
        "applicationId": "db9c4c3d-477c-4d5a-817b-318276713565",
        "audience": "db9c4c3d-477c-4d5a-817b-318276713565",
        "objectId": "e50236ad-ad07-47d4-af71-ed7b52d200d5",
        "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47"
      }
    },
    "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.OffAzure/MasterSites/fci-ankit-test6065mastersite/SqlSites/fci-ankit-test6065sqlsites"
  }
}

Exemple de réponse

Code d’état:: 200

{
  "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-test6904project/sqlcollectors/fci-test0c1esqlsitecollector",
  "name": "fci-test0c1esqlsitecollector",
  "systemData": {
    "createdAt": "0001-01-01T00:00:00",
    "createdBy": null,
    "createdByType": null,
    "lastModifiedAt": "0001-01-01T00:00:00",
    "lastModifiedBy": null,
    "lastModifiedByType": null
  },
  "type": "Microsoft.Migrate/assessmentprojects/sqlcollectors",
  "properties": {
    "agentProperties": {
      "id": "630da710-4d44-41f7-a189-72fe3db5502b-agent",
      "version": null,
      "lastHeartbeatUtc": null,
      "spnDetails": {
        "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47",
        "applicationId": "db9c4c3d-477c-4d5a-817b-318276713565",
        "audience": "db9c4c3d-477c-4d5a-817b-318276713565",
        "objectId": "e50236ad-ad07-47d4-af71-ed7b52d200d5",
        "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47"
      }
    },
    "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.OffAzure/MasterSites/fci-ankit-test6065mastersite/SqlSites/fci-ankit-test6065sqlsites",
    "createdTimestamp": "2022-11-22T09:50:37.1061418Z",
    "updatedTimestamp": "2023-02-16T12:17:52.9185188Z"
  }
}

Code d’état:: 201

Azure-AsyncOperation: https://contoso.com/operationstatus

{
  "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-test6904project/sqlcollectors/fci-test0c1esqlsitecollector",
  "name": "fci-test0c1esqlsitecollector",
  "systemData": {
    "createdAt": "0001-01-01T00:00:00",
    "createdBy": null,
    "createdByType": null,
    "lastModifiedAt": "0001-01-01T00:00:00",
    "lastModifiedBy": null,
    "lastModifiedByType": null
  },
  "type": "Microsoft.Migrate/assessmentprojects/sqlcollectors",
  "properties": {
    "agentProperties": {
      "id": "630da710-4d44-41f7-a189-72fe3db5502b-agent",
      "version": null,
      "lastHeartbeatUtc": null,
      "spnDetails": {
        "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47",
        "applicationId": "db9c4c3d-477c-4d5a-817b-318276713565",
        "audience": "db9c4c3d-477c-4d5a-817b-318276713565",
        "objectId": "e50236ad-ad07-47d4-af71-ed7b52d200d5",
        "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47"
      }
    },
    "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.OffAzure/MasterSites/fci-ankit-test6065mastersite/SqlSites/fci-ankit-test6065sqlsites",
    "createdTimestamp": "2022-11-22T09:50:37.1061418Z",
    "updatedTimestamp": "2023-02-16T12:17:52.9185188Z"
  }
}

Définitions

Nom	Description
CollectorAgentPropertiesBase	Classe de propriété de l’agent collecteur.
CollectorAgentSpnPropertiesBase	Classe de détails SPN de l’agent collecteur.
createdByType	Type d’identité qui a créé la ressource.
ErrorDetail	Détails de l’erreur
ErrorResponse	Réponse d’erreur
ProvisioningState	État de l’opération actuelle.
SqlCollector	Objet REST du collecteur SQL.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

CollectorAgentPropertiesBase

Object

Classe de propriété de l’agent collecteur.

Nom	Type	Description
id	string	Obtient l’ID de l’agent collecteur.
lastHeartbeatUtc	string (date-time)	Obtient l’heure de la dernière pulsation du collecteur.
spnDetails	CollectorAgentSpnPropertiesBase	Obtient ou définit les détails du SPN.
version	string	Obtient la version de l’agent collecteur.

CollectorAgentSpnPropertiesBase

Object

Classe de détails SPN de l’agent collecteur.

Nom	Type	Description
applicationId	string	Obtient l’ID d’application AAD.
audience	string	Obtient l’URL de l’audience AAD.
authority	string	Obtient le point de terminaison d’autorité AAD.
objectId	string	Obtient l’ID d’objet de l’application AAD.
tenantId	string	Obtient l’ID de locataire de l’application AAD.

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
User
Application
ManagedIdentity
Key

ErrorDetail

Object

Détails de l’erreur

Nom	Type	Description
code	string	Code d’erreur
message	string	Description de l’erreur s’est produite

ErrorResponse

Object

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

ProvisioningState

Énumération

État de l’opération actuelle.

Valeur	Description
Succeeded	La ressource a été créée.
Failed	Échec de la création de ressources.
Canceled	La création de ressources a été annulée.
Provisioning	La ressource est en cours d’approvisionnement.
Updating	La ressource est mise à jour.
Deleting	La ressource est supprimée.
Accepted	La ressource est acceptée.

SqlCollector

Object

Objet REST du collecteur SQL.

Nom	Type	Description
id	string (arm-id)	ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »
name	string	Nom de la ressource
properties.agentProperties	CollectorAgentPropertiesBase	Obtient ou définit les propriétés de l’agent collecteur.
properties.createdTimestamp	string (date-time)	Obtient l’horodatage lors de la création du collecteur.
properties.discoverySiteId	string	Obtient l’ID de site de découverte.
properties.provisioningState	ProvisioningState	État de la dernière opération.
properties.updatedTimestamp	string (date-time)	Horodatage lors de la dernière mise à jour du collecteur.
systemData	systemData	Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

systemData

Object

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.

Partager via

Sql Collector Operations - Create

Paramètres URI

Corps de la demande

Réponses

Sécurité

azure_auth

Étendues

Exemples

SqlCollectorOperations_Create_MaximumSet_Gen

Exemple de requête

Exemple de réponse

Définitions

CollectorAgentPropertiesBase

CollectorAgentSpnPropertiesBase

createdByType

ErrorDetail

ErrorResponse

ProvisioningState

SqlCollector

systemData