Subscriptions - Check Zone Peers

Serviço:: Resource Management

Versão da API:: 2022-12-01

Compara um mapeamento de zona lógica de assinaturas

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Resources/checkZonePeers/?api-version=2022-12-01

Parâmetros do URI

Name	Em	Obrigatório	Tipo	Descrição
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser um UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo do Pedido

Name	Tipo	Descrição
location	string	A localização da Microsoft.
subscriptionIds	string[]	A ID de assinatura do Microsoft Azure de mesmo nível.

Respostas

Name	Tipo	Descrição
200 OK	CheckZonePeersResult	O pedido foi bem-sucedido.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Descrição
user_impersonation	personificar a sua conta de utilizador

Exemplos

GetLogicalZoneMapping

Pedido de amostra

POST https://management.azure.com/subscriptions/8d65815f-a5b6-402f-9298-045155da7d74/providers/Microsoft.Resources/checkZonePeers/?api-version=2022-12-01

{
  "location": "eastus",
  "subscriptionIds": [
    "subscriptions/11111111-1111-1111-1111-111111111111"
  ]
}

from azure.identity import DefaultAzureCredential

from azure.mgmt.resource.subscriptions import SubscriptionClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-resource-subscriptions
# USAGE
    python post_check_zone_peers.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SubscriptionClient(
        credential=DefaultAzureCredential(),
    )

    response = client.subscriptions.check_zone_peers(
        subscription_id="8d65815f-a5b6-402f-9298-045155da7d74",
        parameters={"location": "eastus", "subscriptionIds": ["subscriptions/11111111-1111-1111-1111-111111111111"]},
    )
    print(response)


# x-ms-original-file: 2022-12-01/PostCheckZonePeers.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armsubscriptions_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armsubscriptions/v2"
)

// Generated from example definition: 2022-12-01/PostCheckZonePeers.json
func ExampleClient_CheckZonePeers() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsubscriptions.NewClientFactory(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewClient().CheckZonePeers(ctx, "8d65815f-a5b6-402f-9298-045155da7d74", armsubscriptions.CheckZonePeersRequest{
		Location: to.Ptr("eastus"),
		SubscriptionIDs: []*string{
			to.Ptr("subscriptions/11111111-1111-1111-1111-111111111111"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armsubscriptions.ClientCheckZonePeersResponse{
	// 	CheckZonePeersResult: armsubscriptions.CheckZonePeersResult{
	// 		AvailabilityZonePeers: []*armsubscriptions.AvailabilityZonePeers{
	// 			{
	// 				AvailabilityZone: to.Ptr("1"),
	// 				Peers: []*armsubscriptions.Peers{
	// 					{
	// 						AvailabilityZone: to.Ptr("3"),
	// 						SubscriptionID: to.Ptr("11111111-1111-1111-1111-111111111111"),
	// 					},
	// 				},
	// 			},
	// 			{
	// 				AvailabilityZone: to.Ptr("2"),
	// 				Peers: []*armsubscriptions.Peers{
	// 					{
	// 						AvailabilityZone: to.Ptr("2"),
	// 						SubscriptionID: to.Ptr("11111111-1111-1111-1111-111111111111"),
	// 					},
	// 				},
	// 			},
	// 			{
	// 				AvailabilityZone: to.Ptr("3"),
	// 				Peers: []*armsubscriptions.Peers{
	// 					{
	// 						AvailabilityZone: to.Ptr("1"),
	// 						SubscriptionID: to.Ptr("11111111-1111-1111-1111-111111111111"),
	// 					},
	// 				},
	// 			},
	// 		},
	// 		Location: to.Ptr("eastus2"),
	// 		SubscriptionID: to.Ptr("8d65815f-a5b6-402f-9298-045155da7d74"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { SubscriptionClient } = require("@azure/arm-resources-subscriptions");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to compares a subscriptions logical zone mapping
 *
 * @summary compares a subscriptions logical zone mapping
 * x-ms-original-file: 2022-12-01/PostCheckZonePeers.json
 */
async function getLogicalZoneMapping() {
  const credential = new DefaultAzureCredential();
  const client = new SubscriptionClient(credential);
  const result = await client.subscriptions.checkZonePeers("8d65815f-a5b6-402f-9298-045155da7d74", {
    location: "eastus",
    subscriptionIds: ["subscriptions/11111111-1111-1111-1111-111111111111"],
  });
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta da amostra

Código de estado:: 200

{
  "availabilityZonePeers": [
    {
      "availabilityZone": "1",
      "peers": [
        {
          "availabilityZone": "3",
          "subscriptionId": "11111111-1111-1111-1111-111111111111"
        }
      ]
    },
    {
      "availabilityZone": "2",
      "peers": [
        {
          "availabilityZone": "2",
          "subscriptionId": "11111111-1111-1111-1111-111111111111"
        }
      ]
    },
    {
      "availabilityZone": "3",
      "peers": [
        {
          "availabilityZone": "1",
          "subscriptionId": "11111111-1111-1111-1111-111111111111"
        }
      ]
    }
  ],
  "location": "eastus2",
  "subscriptionId": "8d65815f-a5b6-402f-9298-045155da7d74"
}

Definições

Name	Descrição
AvailabilityZonePeers	Lista de zonas de disponibilidade compartilhadas pelas assinaturas.
CheckZonePeersRequest	Verifique os parâmetros de solicitação de pares de zona.
CheckZonePeersResult	Resultado da operação Verificar pares de zona.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
Peers	Informações sobre zona de disponibilidade compartilhada.

AvailabilityZonePeers

Object

Lista de zonas de disponibilidade compartilhadas pelas assinaturas.

Name	Tipo	Descrição
availabilityZone	string	A availabilityZone.
peers	Peers[]	Detalhes da zona de disponibilidade compartilhada.

CheckZonePeersRequest

Object

Verifique os parâmetros de solicitação de pares de zona.

Name	Tipo	Descrição
location	string	A localização da Microsoft.
subscriptionIds	string[]	A ID de assinatura do Microsoft Azure de mesmo nível.

CheckZonePeersResult

Object

Resultado da operação Verificar pares de zona.

Name	Tipo	Descrição
availabilityZonePeers	AvailabilityZonePeers[]	As Zonas de Disponibilidade partilhadas pelas subscrições.
location	string	a localização da subscrição.
subscriptionId	string	O ID da subscrição.

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Descrição
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Descrição
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Object

Resposta de erro

Name	Tipo	Descrição
error	ErrorDetail	O objeto de erro.

Peers

Object

Informações sobre zona de disponibilidade compartilhada.

Name	Tipo	Descrição
availabilityZone	string	A availabilityZone.
subscriptionId	string	O ID da subscrição.