Organization - List Regions

Service:

Confluent

Version d'API:

2024-07-01

régions de fournisseur cloud disponibles pour la création de clusters de Registre de schémas.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
organizationName	path	True	string	Nom de la ressource de l’organisation
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
searchFilters	object	Filtres de recherche pour la requête

Réponses

Nom	Type	Description
200 OK	ListRegionsSuccessResponse	L’opération Azure s’est terminée avec succès.
Other Status Codes	ResourceProviderDefaultErrorResponse	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

Organization_ListRegions

Exemple de requête

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"
  }
}

Exemple de réponse

Code d’état:

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"
        }
      }
    }
  ]
}

Définitions

Nom	Description
ErrorResponseBody	Corps de réponse de l’erreur
ListAccessRequestModel	Modèle de demande d’accès de liste
ListRegionsSuccessResponse	Résultat de la requête POST pour lister les régions prises en charge par confluent
RegionRecord	Détails de l’enregistrement de région
RegionSpecEntity	Détails des spécifications de région
ResourceProviderDefaultErrorResponse	Réponse d’erreur par défaut pour le fournisseur de ressources
SCMetadataEntity	Métadonnées de l’enregistrement de données

ErrorResponseBody

Object

Corps de réponse de l’erreur

Nom	Type	Description
code	string	Code d’erreur
details	ErrorResponseBody[]	Détails de l’erreur
message	string	Message d'erreur
target	string	Cible d’erreur

ListAccessRequestModel

Object

Modèle de demande d’accès de liste

Nom	Type	Description
searchFilters	object	Filtres de recherche pour la requête

ListRegionsSuccessResponse

Object

Résultat de la requête POST pour lister les régions prises en charge par confluent

Nom	Type	Description
data	RegionRecord[]	Liste des régions prises en charge par confluent

RegionRecord

Object

Détails de l’enregistrement de région

Nom	Type	Description
id	string	ID du cluster
kind	string	Type de cluster
properties.metadata	SCMetadataEntity	Métadonnées de l’enregistrement
properties.spec	RegionSpecEntity	Spécification de la région

RegionSpecEntity

Object

Détails des spécifications de région

Nom	Type	Description
cloud	string	Nom du fournisseur de cloud
name	string	Nom complet de la région
packages	string[]
regionName	string	Nom de la région

ResourceProviderDefaultErrorResponse

Object

Réponse d’erreur par défaut pour le fournisseur de ressources

Nom	Type	Description
error	ErrorResponseBody	Corps de réponse de l’erreur

SCMetadataEntity

Object

Métadonnées de l’enregistrement de données

Nom	Type	Description
createdTimestamp	string	Date de création
deletedTimestamp	string	Date supprimée
resourceName	string	Nom de la ressource de l’enregistrement
self	string	URL de recherche automatique
updatedTimestamp	string	Date de mise à jour de l’heure