Availability Group Listeners - Create Or Update

Crée ou met à jour un écouteur de groupe de disponibilité.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}/availabilityGroupListeners/{availabilityGroupListenerName}?api-version=2021-11-01-preview

Paramètres URI

Name In Required Type Description
availabilityGroupListenerName
path True
  • string

Nom de l’écouteur du groupe de disponibilité.

resourceGroupName
path True
  • string

Nom du groupe de ressources qui contient la ressource. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager ou du portail.

sqlVirtualMachineGroupName
path True
  • string

Nom du groupe de machines virtuelles SQL.

subscriptionId
path True
  • string

ID d’abonnement qui identifie un abonnement Azure.

api-version
query True
  • string

Version de l’API à utiliser pour la demande.

Corps de la demande

Name Type Description
properties.availabilityGroupConfiguration

Configuration du groupe de disponibilité.

properties.availabilityGroupName
  • string

Nom du groupe de disponibilité.

properties.createDefaultAvailabilityGroupIfNotExist
  • boolean

Créez un groupe de disponibilité par défaut s’il n’existe pas.

properties.loadBalancerConfigurations

Liste des configurations d’équilibreur de charge pour un écouteur de groupe de disponibilité.

properties.port
  • integer

Port de l’écouteur.

Réponses

Name Type Description
200 OK

Mise à jour réussie de l’écouteur du groupe de disponibilité.

201 Created

Création réussie de l’écouteur de groupe de disponibilité.

Other Status Codes

Réponses d’erreur : ***

  • 400 InvalidParameterValue - Une valeur non valide a été donnée au paramètre.

  • 400 RPGenericUser - Échec de l’utilisateur lors de l’appel d’un autre fournisseur de ressources.

  • 400 RPResponseMissingAsyncOperationHeader - La réponse ne contient pas d’informations d’en-tête d’opération asynchrone

  • 400 InvalidArgument - Argument non valide '{0}'.

  • 400 ArgumentNotInRange - Argument '{0}' non dans la plage.

  • 400 ResourceNotProvisioned - Comme la ressource : {0} n’est pas dans un état approvisionné, la demande ne peut pas être transférée vers l’avant

  • 400 CRPNotAllowedOperation - Impossible d’effectuer l’opération en raison de l’erreur suivante : {0}

  • 400 AadAppDisabled - L’application Microsoft AAD SQLVMResourceProviderAuth ({0}) est désactivée dans votre locataire.

  • 400 InvalidRgResourceId - ID de ressource Resourcegroup non valide spécifié.

  • 400 InternalAPIAccessDenied - Accès d’API interne refusé. L’ID d’application {0} n’est pas valide pour utiliser cette API.

  • 400 AgDoesNotExist - Le groupe de disponibilité n’existe pas.

  • 400 AgListDoesNotMatch - SQL liste des groupes de disponibilité ne correspond pas à la liste des machines virtuelles dans SQL groupe de machines virtuelles.

  • 400 NoIpProvided : au moins une adresse IP doit être fournie.

  • 400 MoreIpProvided : une seule adresse IP doit être fournie.

  • 400 SqlVmGroupDoesNotHaveAGListener - SQL groupe de machines virtuelles ne dispose pas de l’écouteur du groupe de disponibilité.

  • 400 AgListenerUpdateNotAllowed : seules quelques propriétés de l’écouteur de groupe de disponibilité peuvent être mises à jour.

  • 400 SqlVmNotInGroup - SQL machine virtuelle ne fait pas partie du groupe.

  • 400 SqlVmListCannotBeEmpty - SQL liste des machines virtuelles ne peut pas être vide.

  • 400 PublicIpNotIPv4 : l’adresse IP publique doit être une adresse IPv4.

  • 400 PublicIPDynamicAllocation - Le mode d’allocation IP publique doit être statique

  • 400 PublicLBInvalid - L’équilibreur de charge spécifié n’est pas public.

  • 400 SubnetMissingFromPrivateIP : le sous-réseau doit être fourni avec une adresse IP privée.

  • 400 IPNotInSubnet - IP ne faisant pas partie du sous-réseau.

  • 400 NoActivePrimaryInAG - Aucun des nœuds dans AvailabilityGroup n’est principal

  • 400 MultipleListenerSameAG - Plusieurs écouteurs de groupe de disponibilité pour le même groupe de disponibilité ne sont pas autorisés.

  • 400 AgListenerNotEmpty - Écouteur de groupe de disponibilité non vide.

  • 400 AgListenerVnetMismatch : le réseau virtuel fourni pour l’écouteur de groupe de disponibilité ne correspond pas au réseau virtuel de l’équilibreur de charge interne.

  • 400 InternalLBInvalid - L’équilibreur de charge spécifié n’est pas interne.

  • 400 InvalidSqlVmResourceIdParameterValue - SQL ID de ressource de machine virtuelle fourni n’est pas valide.

  • 400 DifferentSubSqlVmList : toutes les machines virtuelles SQL doivent être sous le même abonnement.

  • 400 OnlyStandardPublicIp : chaque machine virtuelle doit avoir une adresse IP publique standard.

  • 400 ListenerNameTooLong - Le nom de l’écouteur ne doit pas dépasser 15 caractères.

  • 400 InvalidListenerName - Nom de l’écouteur non valide.

  • 400 InvalidLBResourceIdParameterValue : l’ID de ressource de l’équilibreur de charge n’est pas valide.

  • 400 InvalidPublicIpResourceIdParameterValue - L’ID de ressource IP publique n’est pas valide.

  • 400 InvalidSubnetIdParameterValue : ID de ressource non valide fourni pour le paramètre de sous-réseau.

  • 400 InvalidPrivateIpParameterValue - Adresse non valide donnée pour l’adresse IP privée.

  • 400 ExtVersionNotSupported - La machine virtuelle : {0} exécute une version antérieure de SqlIaasExtension qui n’est pas prise en charge par cette opération. Mettez à jour l’extension et réessayez l’opération.

  • 400 InvalidReplicaRole - Rôle de réplica non valide : {0} spécifié pour SQL machine virtuelle : {1}.

  • 400 InvalidReplicaFailover - Basculement de réplica non valide : {0} pour SQL machine virtuelle : {1}.

  • 400 InvalidReplicaReadableSecondary - Réplica secondaire réplica non valide : {0} pour SQL machine virtuelle : {1}.

  • 400 InvalidReplicaCommit - Mode de validation de réplica non valide : {0} pour SQL machine virtuelle : {1}.

  • 400 ExpectedSynchronousCommitForAutomaticFailover - Mode de validation de réplica non valide : {0} pour SQL machine virtuelle : {1}. {2} est attendu pour le mode de basculement : {3}.

  • 400 NoPrimaryInAg - Il n’existe aucun réplica avec le rôle principal. Il doit y avoir exactement un réplica avec le rôle principal.

  • 400 MoreThanOnePrimaryInAg - Il existe plusieurs réplicas avec un rôle principal. Il doit y avoir exactement un réplica avec le rôle principal.

  • 400 MoreThanThreeSynchronousCommitInAg - Il existe plus de trois réplicas avec le mode de validation comme suit : {0} Il doit y avoir au plus trois réplicas avec le mode de validation comme suit : {0}

  • 400 MoreThanEightSecondariesInAg : il existe plus de huit réplicas secondaires avec un rôle secondaire. Il doit y avoir au plus huit réplicas avec un rôle secondaire.

  • 400 AlwaysOnNotEnabled - La fonctionnalité Always On n’est pas activée sur la machine virtuelle : {0}.

  • 400 ExpectedReplicaNotPrimary : la machine virtuelle : {0} n’héberge pas le réplica principal.

  • 400 LoadBalancerSqlvmsMismatchWithReplicaSqlvms : la liste des machines virtuelles SQL spécifiées dans le groupe de disponibilité ne correspond pas à la liste des machines virtuelles SQL dans la configuration de l’équilibreur de charge.

  • 400 ReplicaSqlvmHasDuplicateEntries : la configuration du réplica doit être unique pour chaque machine virtuelle SQL. Nous avons trouvé une ou plusieurs configurations pour la même ressource de machine virtuelle SQL.

  • 400 ReplicaDeleteNotAllowed : la suppression du réplica via SQL rp de machine virtuelle n’est pas encore prise en charge.

  • 400 OnlyBasicPublicIP - Toutes les machines virtuelles spécifiées doivent contenir uniquement une adresse IP publique de base, lors de la fourniture de la référence SKU De base loadbalancer.

  • 400 NICCannotUseMultipleLBsOfSameType - NIC : {0} ne peut pas référencer plusieurs équilibreurs de charge de type INTERNAL ou PUBLIC

  • 400 AGReplicaSQLStartupAccount - Le compte de service NT ne peut pas être utilisé comme compte de démarrage SQL pour la configuration du groupe de disponibilité. Vous devez utiliser un compte de domaine.

  • 400 AgListenerMultiSubnetUpdateNotAllowed - La mise à jour de l’écouteur de groupe de disponibilité multi-sous-réseau n’est pas autorisée.

  • 400 ListenerIpSubnetVmSubnetMismatch - Le sous-réseau d’adresses IP statiques de l’écouteur et le sous-réseau de machine virtuelle doivent être identiques

  • 400 VmNicVnetMismatch - Incompatibilité de réseau virtuel de machine virtuelle.

  • 400 NoAvailabilitySet - La machine virtuelle n’est associée à aucun groupe à haute disponibilité.

  • 400 AvailabilitySetMismatch - Le groupe à haute disponibilité des machines virtuelles ne correspond pas.

  • 400 MismatchVmGroupSubscription - Id d’abonnement pour SQL machine virtuelle et SQL groupe de machines virtuelles sont différents.

  • 400 VmNotRunning : la machine virtuelle n’est pas en cours d’exécution.

  • 400 VmAgentNotRunning : l’agent de machine virtuelle n’est pas installé ou en cours d’exécution.

  • 400 NoIpAvailable - Aucune adresse IP disponible.

  • 403 AccessDenied - Accès refusé.

  • 404 ResourceNotFound : la ressource demandée est introuvable.

  • 404 SubscriptionDoesNotExist - L’ID d’abonnement n’existe pas.

  • 404 ResourceDoesNotExist - La ressource n’existe pas.

  • 404 RPOperationNotFound - Opération introuvable

  • 404 OperationIdNotFound - L’ID d’opération est introuvable.

  • 404 OperationTypeNotFound - Type d’opération introuvable.

  • 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - L’abonnement n’a pas SQL groupe de machines virtuelles dans le groupe de ressources.

  • 409 ResourceAlreadyExists : la ressource existe déjà.

  • 409 LBGenericErrors - Échec de l’opération LB

  • 409 NICGenericError - Échec de l’opération de carte réseau

  • 409 SqlExtensionNotInstalled - SQL extension non installée.

  • 409 RPPluginSubstatusMissing - Sous-état du plug-in RP manquant

  • 409 MissingMoveResources : impossible de déplacer des ressources, car certaines ressources sont manquantes dans la requête.

  • 409 ResourceExists - Une erreur interne s’est produite lors du nettoyage des ressources.

  • 409 SubscriptionOperationInProgress - Une opération sur l’abonnement est déjà en cours

  • 409 OperationInProgress : opération en cours sur la ressource déjà.

  • 409 OperationCanceled - Opération annulée.

  • 409 ReplicasWithDifferentSqlStartupAccounts : vérifiez que tous vos comptes de démarrage de serveur SQL dans les réplicas spécifiés sont identiques. Il s’agit de l’une de nos conditions préalables à la configuration des groupes de disponibilité.

  • 409 ReplicasJoinedToMoreThanOneCluster - Les réplicas de groupe de disponibilité sont joints à plusieurs clusters de basculement. Vérifiez que tous vos réplicas sont joints au même cluster de basculement.

  • 409 IPNotAvailable : l’adresse IP {0} n’est pas disponible{1}. Envisagez d’en utiliser un à partir de ({2})

  • 409 IpAddressAlreadyReserved - L’adresse IP réservée à cet écouteur existe déjà. Utilisez l’adresse IP

  • 429 TooManyRequestsReceived -

  • 500 RPGenericSystem - Échec système lors de l’appel d’un autre fournisseur de ressources.

  • 500 UnExpectedErrorOccurred - Une erreur inattendue s’est produite.

  • 500 OperationTimeout - L’opération a expiré.

  • 500 SqlVmGroupIsBusy - SQL groupe de machines virtuelles est occupé.

Exemples

Creates or updates an availability group listener.

Sample Request

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/testvmgroup/availabilityGroupListeners/agl-test?api-version=2021-11-01-preview

{
  "properties": {
    "availabilityGroupName": "ag-test",
    "loadBalancerConfigurations": [
      {
        "privateIpAddress": {
          "ipAddress": "10.1.0.112",
          "subnetResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/default"
        },
        "loadBalancerResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb-test",
        "probePort": 59983,
        "sqlVirtualMachineInstances": [
          "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm2",
          "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm3"
        ]
      }
    ],
    "port": 1433
  }
}

Sample Response

{
  "properties": {
    "provisioningState": "Updating",
    "loadBalancerConfigurations": [
      {
        "privateIpAddress": {
          "ipAddress": "10.1.0.113",
          "subnetResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/default"
        },
        "sqlVirtualMachineInstances": [
          "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm2",
          "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm3"
        ]
      }
    ],
    "port": 1433
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/testvmgroup/availabilityGroupListeners/agl-test",
  "name": "agl-test",
  "type": "Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/availabilityGroupListeners"
}
{
  "properties": {
    "provisioningState": "Provisioning",
    "loadBalancerConfigurations": [
      {
        "privateIpAddress": {
          "ipAddress": "10.1.0.112",
          "subnetResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/default"
        },
        "sqlVirtualMachineInstances": [
          "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm2",
          "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm3"
        ]
      }
    ],
    "port": 1433
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/testvmgroup/availabilityGroupListeners/agl-test",
  "name": "agl-test",
  "type": "Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/availabilityGroupListeners"
}

Définitions

AgConfiguration

Configuration du groupe de disponibilité.

AgReplica

Configuration du réplica de groupe de disponibilité.

AvailabilityGroupListener

Écouteur de groupe de disponibilité SQL Server.

Commit

Mode de validation du réplica dans le groupe de disponibilité.

createdByType

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

Failover

Mode de basculement du réplica dans le groupe de disponibilité.

LoadBalancerConfiguration

Configuration de l’équilibreur de charge pour un écouteur de groupe de disponibilité.

PrivateIPAddress

Adresse IP privée liée à l’écouteur du groupe de disponibilité.

ReadableSecondary

Mode secondaire lisible du réplica dans le groupe de disponibilité.

Role

Rôle de réplica dans le groupe de disponibilité.

systemData

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

AgConfiguration

Configuration du groupe de disponibilité.

Name Type Description
replicas

Configurations de réplica.

AgReplica

Configuration du réplica de groupe de disponibilité.

Name Type Description
commit

Mode de validation du réplica dans le groupe de disponibilité.

failover

Mode de basculement du réplica dans le groupe de disponibilité.

readableSecondary

Mode secondaire lisible du réplica dans le groupe de disponibilité.

role

Rôle de réplica dans le groupe de disponibilité.

sqlVirtualMachineInstanceId
  • string

ID d’instance Sql VirtualMachine.

AvailabilityGroupListener

Écouteur de groupe de disponibilité SQL Server.

Name Type Description
id
  • string

ID de la ressource

name
  • string

Nom de la ressource.

properties.availabilityGroupConfiguration

Configuration du groupe de disponibilité.

properties.availabilityGroupName
  • string

Nom du groupe de disponibilité.

properties.createDefaultAvailabilityGroupIfNotExist
  • boolean

Créez un groupe de disponibilité par défaut s’il n’existe pas.

properties.loadBalancerConfigurations

Liste des configurations d’équilibreur de charge pour un écouteur de groupe de disponibilité.

properties.port
  • integer

Port de l’écouteur.

properties.provisioningState
  • string

État d’approvisionnement pour suivre l’état de l’opération asynchrone.

systemData

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

type
  • string

Type de ressource.

Commit

Mode de validation du réplica dans le groupe de disponibilité.

Name Type Description
ASYNCHRONOUS_COMMIT
  • string
SYNCHRONOUS_COMMIT
  • string

createdByType

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

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

Failover

Mode de basculement du réplica dans le groupe de disponibilité.

Name Type Description
AUTOMATIC
  • string
MANUAL
  • string

LoadBalancerConfiguration

Configuration de l’équilibreur de charge pour un écouteur de groupe de disponibilité.

Name Type Description
loadBalancerResourceId
  • string

ID de ressource de l’équilibreur de charge.

privateIpAddress

Adresse IP privée.

probePort
  • integer

Port de sonde.

publicIpAddressResourceId
  • string

ID de ressource de l’adresse IP publique.

sqlVirtualMachineInstances
  • string[]

Liste des id de ressource d’instance de machine virtuelle SQL inscrits dans l’écouteur du groupe de disponibilité.

PrivateIPAddress

Adresse IP privée liée à l’écouteur du groupe de disponibilité.

Name Type Description
ipAddress
  • string

Adresse IP privée liée à l’écouteur de groupe de disponibilité.

subnetResourceId
  • string

Sous-réseau utilisé pour inclure une adresse IP privée.

ReadableSecondary

Mode secondaire lisible du réplica dans le groupe de disponibilité.

Name Type Description
ALL
  • string
NO
  • string
READ_ONLY
  • string

Role

Rôle de réplica dans le groupe de disponibilité.

Name Type Description
PRIMARY
  • string
SECONDARY
  • string

systemData

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

Name Type Description
createdAt
  • string

Horodatage de la création de ressources (UTC).

createdBy
  • string

Identité qui a créé la ressource.

createdByType

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

lastModifiedAt
  • string

Horodatage de la dernière modification de la ressource (UTC)

lastModifiedBy
  • string

Identité qui a modifié la ressource pour la dernière fois.

lastModifiedByType

Type d’identité qui a modifié la ressource pour la dernière fois.