Deployments - Create Or Update

Dienst:

API Center

API-Version:

2024-03-01

Erstellt neue oder aktualisiert vorhandene API-Bereitstellung.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}/deployments/{deploymentName}?api-version=2024-03-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
apiName	path	True	string minLength: 1 maxLength: 90 pattern: ^[a-zA-Z0-9-]{3,90}$	Der Name der API.
deploymentName	path	True	string minLength: 1 maxLength: 90 pattern: ^[a-zA-Z0-9-]{3,90}$	Der Name der API-Bereitstellung.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
serviceName	path	True	string minLength: 1 maxLength: 90 pattern: ^[a-zA-Z0-9-]{3,90}$	Der Name des Azure API Center-Diensts.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
workspaceName	path	True	string minLength: 1 maxLength: 90 pattern: ^[a-zA-Z0-9-]{3,90}$	Der Name des Arbeitsbereichs.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Typ	Beschreibung
properties.customProperties	object	Benutzerdefinierte Eigenschaften Die benutzerdefinierten Metadaten, die für API-Katalogentitäten definiert sind.
properties.definitionId	string	API-zentrierte Definitionsressourcen-ID.
properties.description	string maxLength: 500	Beschreibung der Bereitstellung.
properties.environmentId	string	API-zentrierte Umgebungsressourcen-ID.
properties.server	DeploymentServer	Der Bereitstellungsserver
properties.state	DeploymentState	Status der API-Bereitstellung.
properties.title	string minLength: 1 maxLength: 50	API-Bereitstellungstitel

Antworten

Name	Typ	Beschreibung
200 OK	Deployment	Der Aktualisierungsvorgang der Ressource "Bereitstellung" war erfolgreich. Header ETag: string
201 Created	Deployment	Der Erstellungsvorgang der Ressource "Bereitstellung" war erfolgreich. Header ETag: string
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Deployments_CreateOrUpdate

Beispielanforderung

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apis/echo-api/deployments/production?api-version=2024-03-01

{
  "properties": {
    "title": "Production deployment",
    "description": "Public cloud production deployment.",
    "environmentId": "/workspaces/default/environments/production",
    "definitionId": "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi",
    "state": "active",
    "server": {
      "runtimeUri": [
        "https://api.contoso.com"
      ]
    }
  }
}

Java

/**
 * Samples for Deployments CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/
     * Deployments_CreateOrUpdate.json
     */
    /**
     * Sample code: Deployments_CreateOrUpdate.
     * 
     * @param manager Entry point to ApiCenterManager.
     */
    public static void deploymentsCreateOrUpdate(com.azure.resourcemanager.apicenter.ApiCenterManager manager) {
        manager.deployments().define("production")
            .withExistingApi("contoso-resources", "contoso", "default", "echo-api").create();
    }
}

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

Go

package armapicenter_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apicenter/armapicenter"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d4205894880b989ede35d62d97c8e901ed14fb5a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Deployments_CreateOrUpdate.json
func ExampleDeploymentsClient_CreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapicenter.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDeploymentsClient().CreateOrUpdate(ctx, "contoso-resources", "contoso", "default", "echo-api", "production", armapicenter.Deployment{}, 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.Deployment = armapicenter.Deployment{
	// 	Name: to.Ptr("production"),
	// 	Type: to.Ptr("Microsoft.ApiCenter/services/apis/deployments"),
	// 	ID: to.Ptr("/subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/deployments/production"),
	// 	SystemData: &armapicenter.SystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-07-03T18:27:09.128Z"); return t}()),
	// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-07-03T18:27:09.128Z"); return t}()),
	// 	},
	// 	Properties: &armapicenter.DeploymentProperties{
	// 		Description: to.Ptr("Public cloud production deployment."),
	// 		DefinitionID: to.Ptr("/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi"),
	// 		EnvironmentID: to.Ptr("/workspaces/default/environments/production"),
	// 		Server: &armapicenter.DeploymentServer{
	// 			RuntimeURI: []*string{
	// 				to.Ptr("https://api.contoso.com")},
	// 			},
	// 			State: to.Ptr(armapicenter.DeploymentStateActive),
	// 			Title: to.Ptr("Production deployment"),
	// 		},
	// 	}
}

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

JavaScript

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

/**
 * This sample demonstrates how to Creates new or updates existing API deployment.
 *
 * @summary Creates new or updates existing API deployment.
 * x-ms-original-file: specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Deployments_CreateOrUpdate.json
 */
async function deploymentsCreateOrUpdate() {
  const subscriptionId =
    process.env["APICENTER_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["APICENTER_RESOURCE_GROUP"] || "contoso-resources";
  const serviceName = "contoso";
  const workspaceName = "default";
  const apiName = "echo-api";
  const deploymentName = "production";
  const payload = {
    properties: {
      description: "Public cloud production deployment.",
      definitionId: "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi",
      environmentId: "/workspaces/default/environments/production",
      server: { runtimeUri: ["https://api.contoso.com"] },
      state: "active",
      title: "Production deployment",
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new AzureAPICenter(credential, subscriptionId);
  const result = await client.deployments.createOrUpdate(
    resourceGroupName,
    serviceName,
    workspaceName,
    apiName,
    deploymentName,
    payload,
  );
  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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ApiCenter;

// Generated from example definition: specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Deployments_CreateOrUpdate.json
// this example is just showing the usage of "Deployments_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ApiCenterDeploymentResource created on azure
// for more information of creating ApiCenterDeploymentResource, please refer to the document of ApiCenterDeploymentResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "contoso-resources";
string serviceName = "contoso";
string workspaceName = "default";
string apiName = "echo-api";
string deploymentName = "production";
ResourceIdentifier apiCenterDeploymentResourceId = ApiCenterDeploymentResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName, workspaceName, apiName, deploymentName);
ApiCenterDeploymentResource apiCenterDeployment = client.GetApiCenterDeploymentResource(apiCenterDeploymentResourceId);

// invoke the operation
ApiCenterDeploymentData data = new ApiCenterDeploymentData();
ArmOperation<ApiCenterDeploymentResource> lro = await apiCenterDeployment.UpdateAsync(WaitUntil.Completed, data);
ApiCenterDeploymentResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ApiCenterDeploymentData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Beispiel für eine Antwort

Statuscode:

200

{
  "type": "Microsoft.ApiCenter/services/apis/deployments",
  "id": "/subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/deployments/production",
  "name": "production",
  "systemData": {
    "createdAt": "2023-07-03T18:27:09.128871Z",
    "lastModifiedAt": "2023-07-03T18:27:09.1288716Z"
  },
  "properties": {
    "title": "Production deployment",
    "description": "Public cloud production deployment.",
    "environmentId": "/workspaces/default/environments/production",
    "definitionId": "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi",
    "state": "active",
    "server": {
      "runtimeUri": [
        "https://api.contoso.com"
      ]
    }
  }
}

Statuscode:

201

{
  "type": "Microsoft.ApiCenter/services/apis/deployments",
  "id": "/subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/deployments/production",
  "name": "production",
  "systemData": {
    "createdAt": "2023-07-03T18:27:09.128871Z",
    "lastModifiedAt": "2023-07-03T18:27:09.1288716Z"
  },
  "properties": {
    "title": "Production deployment",
    "description": "Public cloud production deployment.",
    "environmentId": "/workspaces/default/environments/production",
    "definitionId": "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi",
    "state": "active",
    "server": {
      "runtimeUri": [
        "https://api.contoso.com"
      ]
    }
  }
}

Definitionen

Name	Beschreibung
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
Deployment	API-Bereitstellungsentität.
DeploymentServer	Server
DeploymentState	Status der Bereitstellung
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

Deployment

Objekt

API-Bereitstellungsentität.

Name	Typ	Beschreibung
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Der Name der Ressource
properties.customProperties	object	Benutzerdefinierte Eigenschaften Die benutzerdefinierten Metadaten, die für API-Katalogentitäten definiert sind.
properties.definitionId	string	API-zentrierte Definitionsressourcen-ID.
properties.description	string maxLength: 500	Beschreibung der Bereitstellung.
properties.environmentId	string	API-zentrierte Umgebungsressourcen-ID.
properties.server	DeploymentServer	Der Bereitstellungsserver
properties.state	DeploymentState	Status der API-Bereitstellung.
properties.title	string minLength: 1 maxLength: 50	API-Bereitstellungstitel
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

DeploymentServer

Objekt

Server

Name	Typ	Beschreibung
runtimeUri	string[] (uri) maxLength: 200	Basislaufzeit-URLs für diese Bereitstellung.

DeploymentState

Enumeration

Status der Bereitstellung

Wert	Beschreibung
active	Aktiver Zustand
inactive	Inaktiver Zustand

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.