Portal Revision - Create Or Update

Riferimento

Service:: API Management

API Version:: 2022-08-01

Crea una nuova revisione del portale per sviluppatori eseguendo la pubblicazione del portale. La isCurrent proprietà indica se la revisione è accessibile pubblicamente.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalRevisions/{portalRevisionId}?api-version=2022-08-01

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
portalRevisionId	path	True	string	Identificatore di revisione del portale. Deve essere univoco nell'istanza corrente del servizio di Gestione API.
resourceGroupName	path	True	string	Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
serviceName	path	True	string	Nome del servizio di Gestione API. Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string	ID della sottoscrizione di destinazione.
api-version	query	True	string	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome	Tipo	Descrizione
properties.description	string	Descrizione della revisione del portale.
properties.isCurrent	boolean	Indica se la revisione del portale è pubblica.

Risposte

Nome	Tipo	Descrizione
201 Created	PortalRevisionContract	La revisione del portale per sviluppatori è stata creata correttamente. Headers ETag: string
202 Accepted		È stata accettata la richiesta di creazione di una revisione del portale per sviluppatori.
Other Status Codes	ErrorResponse	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Nome

Tipo

Descrizione

201 Created

PortalRevisionContract

La revisione del portale per sviluppatori è stata creata correttamente.

Headers

ETag: string

202 Accepted

È stata accettata la richiesta di creazione di una revisione del portale per sviluppatori.

Other Status Codes

ErrorResponse

Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

ApiManagementCreatePortalRevision

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalRevisions/20201112101010?api-version=2022-08-01

{
  "properties": {
    "description": "portal revision 1",
    "isCurrent": true
  }
}

/** Samples for PortalRevision CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreatePortalRevision.json
     */
    /**
     * Sample code: ApiManagementCreatePortalRevision.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementCreatePortalRevision(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .portalRevisions()
            .define("20201112101010")
            .withExistingService("rg1", "apimService1")
            .withDescription("portal revision 1")
            .withIsCurrent(true)
            .create();
    }
}

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

from typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_create_portal_revision.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 = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.portal_revision.begin_create_or_update(
        resource_group_name="rg1",
        service_name="apimService1",
        portal_revision_id="20201112101010",
        parameters={"properties": {"description": "portal revision 1", "isCurrent": True}},
    ).result()
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreatePortalRevision.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 armapimanagement_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/apimanagement/armapimanagement/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreatePortalRevision.json
func ExamplePortalRevisionClient_BeginCreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewPortalRevisionClient().BeginCreateOrUpdate(ctx, "rg1", "apimService1", "20201112101010", armapimanagement.PortalRevisionContract{
		Properties: &armapimanagement.PortalRevisionContractProperties{
			Description: to.Ptr("portal revision 1"),
			IsCurrent:   to.Ptr(true),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

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

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates a new developer portal's revision by running the portal's publishing. The `isCurrent` property indicates if the revision is publicly accessible.
 *
 * @summary Creates a new developer portal's revision by running the portal's publishing. The `isCurrent` property indicates if the revision is publicly accessible.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreatePortalRevision.json
 */
async function apiManagementCreatePortalRevision() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const portalRevisionId = "20201112101010";
  const parameters = {
    description: "portal revision 1",
    isCurrent: true,
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.portalRevision.beginCreateOrUpdateAndWait(
    resourceGroupName,
    serviceName,
    portalRevisionId,
    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

Sample Response

Status code:: 202

location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalRevisions/20201112101010?api-version=2022-08-01&asyncId=5faf089b1d9a026694220e0c&asyncCode=201

Status code:: 201

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalRevisions/20201112101010",
  "type": "Microsoft.ApiManagement/service/portalRevisions",
  "name": "20201112101010",
  "properties": {
    "description": "portal revision 1",
    "statusDetails": null,
    "status": "completed",
    "isCurrent": true,
    "createdDateTime": "2020-11-13T22:28:43.657Z",
    "updatedDateTime": "2020-11-13T22:29:22.68Z"
  }
}

Definizioni

Nome	Descrizione
ErrorFieldContract	Contratto campo di errore.
ErrorResponse	Risposta errore.
PortalRevisionContract	Dettagli del contratto di revisione del portale.
portalRevisionStatus	Stato della revisione del portale.

ErrorFieldContract

Contratto campo di errore.

Nome	Tipo	Descrizione
code	string	Codice di errore a livello di proprietà.
message	string	Rappresentazione leggibile dell'errore a livello di proprietà.
target	string	Nome della proprietà.

ErrorResponse

Risposta errore.

Nome	Tipo	Descrizione
error.code	string	Codice di errore definito dal servizio. Questo codice svolge la funzione di stato secondario per il codice di errore HTTP specificato nella risposta.
error.details	ErrorFieldContract[]	Elenco di campi non validi inviati nella richiesta, in caso di errore di convalida.
error.message	string	Rappresentazione leggibile dell'errore.

PortalRevisionContract

Dettagli del contratto di revisione del portale.

Nome	Tipo	Descrizione
id	string	ID di risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	nome della risorsa.
properties.createdDateTime	string	Data e ora di creazione della revisione del portale.
properties.description	string	Descrizione della revisione del portale.
properties.isCurrent	boolean	Indica se la revisione del portale è pubblica.
properties.status	portalRevisionStatus	Stato della revisione del portale.
properties.statusDetails	string	Dettagli sullo stato di pubblicazione delle revisioni del portale.
properties.updatedDateTime	string	Data e ora dell'ultimo aggiornamento.
type	string	Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

portalRevisionStatus

Stato della revisione del portale.

Nome	Tipo	Descrizione
completed	string	Pubblicazione di revisione del portale completata.
failed	string	La pubblicazione delle revisioni del portale non è riuscita.
pending	string	La revisione del portale è stata accodata.
publishing	string	La revisione del portale è in fase di pubblicazione.

Share via

Portal Revision - Create Or Update

Parametri dell'URI

Corpo della richiesta

Risposte

Sicurezza

azure_auth

Scopes

Esempio

ApiManagementCreatePortalRevision

Sample Request

Sample Response

Definizioni

ErrorFieldContract

ErrorResponse

PortalRevisionContract

portalRevisionStatus

Risorse aggiuntive