Sql Collector Operations - List By Assessment Project

Dienst:

Azure Migrate

API-Version:

2024-01-15

Auflisten von SqlCollector-Ressourcen nach AssessmentProject

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
projectName	path	True	string pattern: ^[^<>&:\?/#]{1,260}$	Name des Bewertungsprojekts
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	SqlCollectorListResult	Der ARM-Vorgang wurde erfolgreich abgeschlossen.
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

SqlCollectorOperations_ListByAssessmentProject_MaximumSet_Gen

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:

200

{
  "value": [
    {
      "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/sqlcollectors/fci-ankit-test0c1esqlsitecollector",
      "name": "fci-ankit-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"
      }
    }
  ],
  "nextLink": null
}

Definitionen

Name	Beschreibung
CollectorAgentPropertiesBase	Collector-Agent-Eigenschaftsklasse.
CollectorAgentSpnPropertiesBase	Sammlungs-Agent-SPN-Detailklasse.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorDetail	Fehlerdetails
ErrorResponse	Fehlerantwort
ProvisioningState	Der Status des aktuellen Vorgangs.
SqlCollector	Das SQL-Sammel-REST-Objekt.
SqlCollectorListResult	Die Antwort eines SqlCollector-Listenvorgangs.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

CollectorAgentPropertiesBase

Objekt

Collector-Agent-Eigenschaftsklasse.

Name	Typ	Beschreibung
id	string	Ruft die Sammel-Agent-ID ab.
lastHeartbeatUtc	string (date-time)	Ruft die letzte Taktzeit des Sammlers ab.
spnDetails	CollectorAgentSpnPropertiesBase	Ruft die SPN-Details ab oder legt diese fest.
version	string	Ruft die Sammlungs-Agent-Version ab.

CollectorAgentSpnPropertiesBase

Objekt

Sammlungs-Agent-SPN-Detailklasse.

Name	Typ	Beschreibung
applicationId	string	Ruft die AAD-Anwendungs-ID ab.
audience	string	Ruft die AAD-Zielgruppen-URL ab.
authority	string	Ruft den AAD-Autoritätsendpunkt ab.
objectId	string	Ruft die Objekt-ID der AAD-Anwendung ab.
tenantId	string	Ruft die Mandanten-ID der AAD-Anwendung ab.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

ErrorDetail

Objekt

Fehlerdetails

Name	Typ	Beschreibung
code	string	Fehlercode
message	string	Beschreibung des aufgetretenen Fehlers

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

ProvisioningState

Enumeration

Der Status des aktuellen Vorgangs.

Wert	Beschreibung
Succeeded	Ressource wurde erstellt.
Failed	Fehler bei der Ressourcenerstellung.
Canceled	Die Ressourcenerstellung wurde abgebrochen.
Provisioning	Die Ressource wird bereitgestellt.
Updating	Die Ressource wird aktualisiert.
Deleting	Die Ressource wird gelöscht.
Accepted	Ressource wird akzeptiert.

SqlCollector

Objekt

Das SQL-Sammel-REST-Objekt.

Name	Typ	Beschreibung
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Der Name der Ressource
properties.agentProperties	CollectorAgentPropertiesBase	Dient zum Abrufen oder Festlegen der Eigenschaften des Sammel-Agents.
properties.createdTimestamp	string (date-time)	Ruft den Zeitstempel ab, als der Sammelsammler erstellt wurde.
properties.discoverySiteId	string	Ruft die Ermittlungswebsite-ID ab.
properties.provisioningState	ProvisioningState	Der Status des letzten Vorgangs.
properties.updatedTimestamp	string (date-time)	Zeitstempel, als der Sammelsammler zuletzt aktualisiert wurde.
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

SqlCollectorListResult

Objekt

Die Antwort eines SqlCollector-Listenvorgangs.

Name	Typ	Beschreibung
nextLink	string (uri)	Der Link zur nächsten Seite von Elementen
value	SqlCollector[]	Die SqlCollector-Elemente auf dieser Seite

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.