Subscriptions - Check Zone Peers

Referencia

Servicio:: Resource Management

Versión de la API:: 2022-12-01

Compara una asignación de zona lógica de suscripciones

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
subscriptionId	path	True	string	Identificador de la suscripción de destino.
api-version	query	True	string	Versión de API que se usará para la operación.

Cuerpo de la solicitud

Nombre	Tipo	Description
location	string	Ubicación de Microsoft.
subscriptionIds	string[]	Identificador de suscripción de Microsoft Azure del mismo nivel.

Respuestas

Nombre	Tipo	Description
200 OK	CheckZonePeersResult	Aceptar: devuelve información sobre la asignación de zona de disponibilidad lógica entre suscripciones.
Other Status Codes	ErrorResponse	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

GetLogicalZoneMapping

Solicitud de ejemplo

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


import com.azure.resourcemanager.resources.models.CheckZonePeersRequest;
import java.util.Arrays;

/**
 * Samples for Subscriptions CheckZonePeers.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostCheckZonePeers.json
     */
    /**
     * Sample code: GetLogicalZoneMapping.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getLogicalZoneMapping(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.genericResources().manager().subscriptionClient().getSubscriptions().checkZonePeersWithResponse(
            "8d65815f-a5b6-402f-9298-045155da7d74", new CheckZonePeersRequest().withLocation("eastus")
                .withSubscriptionIds(Arrays.asList("subscriptions/11111111-1111-1111-1111-111111111111")),
            com.azure.core.util.Context.NONE);
    }
}

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.resource import SubscriptionClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-resource
# 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: specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/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"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4f4073bdb028bc84bc3e6405c1cbaf8e89b83caf/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/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.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: specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostCheckZonePeers.json
 */
async function getLogicalZoneMapping() {
  const subscriptionId = "8d65815f-a5b6-402f-9298-045155da7d74";
  const parameters = {
    location: "eastus",
    subscriptionIds: ["subscriptions/11111111-1111-1111-1111-111111111111"],
  };
  const credential = new DefaultAzureCredential();
  const client = new SubscriptionClient(credential);
  const result = await client.subscriptions.checkZonePeers(subscriptionId, parameters);
  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

Respuesta de muestra

status code:: 200

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

Definiciones

Nombre	Description
AvailabilityZonePeers	Lista de zonas de disponibilidad compartidas por las suscripciones.
CheckZonePeersRequest	Compruebe los parámetros de solicitud del mismo nivel de zona.
CheckZonePeersResult	Resultado de la operación Comprobar elementos del mismo nivel de zona.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
Peers	Información sobre la zona de disponibilidad compartida.

AvailabilityZonePeers

Lista de zonas de disponibilidad compartidas por las suscripciones.

Nombre	Tipo	Description
availabilityZone	string	AvailabilityZone.
peers	Peers[]	Detalles de la zona de disponibilidad compartida.

CheckZonePeersRequest

Compruebe los parámetros de solicitud del mismo nivel de zona.

Nombre	Tipo	Description
location	string	Ubicación de Microsoft.
subscriptionIds	string[]	Identificador de suscripción de Microsoft Azure del mismo nivel.

CheckZonePeersResult

Resultado de la operación Comprobar elementos del mismo nivel de zona.

Nombre	Tipo	Description
availabilityZonePeers	AvailabilityZonePeers[]	El Availability Zones compartido por las suscripciones.
location	string	la ubicación de la suscripción.
subscriptionId	string	Identificador de la suscripción.

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

Peers

Información sobre la zona de disponibilidad compartida.

Nombre	Tipo	Description
availabilityZone	string	AvailabilityZone.
subscriptionId	string	Identificador de la suscripción.

Compartir a través de

Subscriptions - Check Zone Peers

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

GetLogicalZoneMapping

Solicitud de ejemplo

Respuesta de muestra

Definiciones

AvailabilityZonePeers

CheckZonePeersRequest

CheckZonePeersResult

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Peers

Recursos adicionales