Organization - List Regions

Dienst:

Confluent

API-Version:

2024-07-01

Cloudanbieterregionen zum Erstellen von Schemaregistrierungsclustern verfügbar.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/listRegions?api-version=2024-07-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
organizationName	path	True	string	Name der Organisationsressource
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.

Anforderungstext

Name	Typ	Beschreibung
searchFilters	object	Suchfilter für die Anforderung

Antworten

Name	Typ	Beschreibung
200 OK	ListRegionsSuccessResponse	Der Azure-Vorgang wurde erfolgreich abgeschlossen.
Other Status Codes	ResourceProviderDefaultErrorResponse	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

Organization_ListRegions

Beispielanforderung

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Confluent/organizations/myOrganization/listRegions?api-version=2024-07-01

{
  "searchFilters": {
    "cloud": "azure",
    "packages": "ADVANCED,ESSENTIALS",
    "region": "eastus"
  }
}

Beispiel für eine Antwort

Statuscode:

200

{
  "data": [
    {
      "id": "sgreg-7",
      "kind": "Region",
      "properties": {
        "metadata": {
          "createdTimestamp": "2023-04-06T10:24:09.840788Z",
          "resourceName": "crn://confluent.cloud/schema-registry-region=sgreg-7",
          "self": "https://api.stag.cpdev.cloud/srcm/v2/regions/sgreg-7",
          "updatedTimestamp": "2023-04-06T10:24:09.840788Z"
        },
        "spec": {
          "name": "Iowa (centralus)",
          "cloud": "AZURE",
          "packages": [
            "ADVANCED"
          ],
          "regionName": "centralus"
        }
      }
    }
  ]
}

Definitionen

Name	Beschreibung
ErrorResponseBody	Antworttext des Fehlers
ListAccessRequestModel	Listenzugriffsanforderungsmodell
ListRegionsSuccessResponse	Ergebnis der POST-Anforderung zum Auflisten von Regionen, die von confluent unterstützt werden
RegionRecord	Details des Regionsdatensatzes
RegionSpecEntity	Regionsspezifikationsdetails
ResourceProviderDefaultErrorResponse	Standardfehlerantwort für Ressourcenanbieter
SCMetadataEntity	Metadaten des Datensatzes

ErrorResponseBody

Objekt

Antworttext des Fehlers

Name	Typ	Beschreibung
code	string	Fehlercode
details	ErrorResponseBody[]	Fehlerdetails
message	string	Fehlermeldung
target	string	Fehlerziel

ListAccessRequestModel

Objekt

Listenzugriffsanforderungsmodell

Name	Typ	Beschreibung
searchFilters	object	Suchfilter für die Anforderung

ListRegionsSuccessResponse

Objekt

Ergebnis der POST-Anforderung zum Auflisten von Regionen, die von confluent unterstützt werden

Name	Typ	Beschreibung
data	RegionRecord[]	Liste der regionen, die von confluent unterstützt werden

RegionRecord

Objekt

Details des Regionsdatensatzes

Name	Typ	Beschreibung
id	string	ID des Clusters
kind	string	Art des Clusters
properties.metadata	SCMetadataEntity	Metadaten des Datensatzes
properties.spec	RegionSpecEntity	Spezifikation der Region

RegionSpecEntity

Objekt

Regionsspezifikationsdetails

Name	Typ	Beschreibung
cloud	string	Name des Cloudanbieters
name	string	Anzeigename des Bereichs
packages	string[]
regionName	string	Regionsname

ResourceProviderDefaultErrorResponse

Objekt

Standardfehlerantwort für Ressourcenanbieter

Name	Typ	Beschreibung
error	ErrorResponseBody	Antworttext des Fehlers

SCMetadataEntity

Objekt

Metadaten des Datensatzes

Name	Typ	Beschreibung
createdTimestamp	string	Erstellungsdatum
deletedTimestamp	string	Gelöschte Uhrzeit
resourceName	string	Ressourcenname des Datensatzes
self	string	Url für self-Nachschlagevorgänge
updatedTimestamp	string	Datumsangabe aktualisiert