Deployments - Create Or Update

Serviço:

API Center

Versão da API:

2024-03-01

Cria ou atualiza a implantação de API existente.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
apiName	path	True	string minLength: 1 maxLength: 90 pattern: ^[a-zA-Z0-9-]{3,90}$	O nome da API.
deploymentName	path	True	string minLength: 1 maxLength: 90 pattern: ^[a-zA-Z0-9-]{3,90}$	O nome da implantação da API.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
serviceName	path	True	string minLength: 1 maxLength: 90 pattern: ^[a-zA-Z0-9-]{3,90}$	O nome do serviço do Centro de API do Azure.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser uma UUID.
workspaceName	path	True	string minLength: 1 maxLength: 90 pattern: ^[a-zA-Z0-9-]{3,90}$	O nome do espaço de trabalho.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Tipo	Description
properties.customProperties	object	Propriedades personalizadas Os metadados personalizados definidos para entidades de catálogo de API.
properties.definitionId	string	ID do recurso de definição no escopo central da API.
properties.description	string maxLength: 500	Descrição da implantação.
properties.environmentId	string	ID do recurso de ambiente com escopo central da API.
properties.server	DeploymentServer	O servidor de implantação
properties.state	DeploymentState	Estado da implantação da API.
properties.title	string minLength: 1 maxLength: 50	Título da implantação da API

Respostas

Nome	Tipo	Description
200 OK	Deployment	Operação de atualização 'Implantação' do recurso bem-sucedida Cabeçalhos ETag: string
201 Created	Deployment	Operação de criação de recurso 'Implantação' bem-sucedida Cabeçalhos ETag: string
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Deployments_CreateOrUpdate

Solicitação de exemplo

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

Resposta de exemplo

Código de status:

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

Código de status:

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

Definições

Nome	Description
createdByType	O tipo de identidade que criou o recurso.
Deployment	Entidade de implantação de API.
DeploymentServer	Servidor
DeploymentState	Estado da implantação
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
systemData	Metadados relativos à criação e última modificação do recurso.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
Application
Key
ManagedIdentity
User

Deployment

Objeto

Entidade de implantação de API.

Nome	Tipo	Description
id	string (arm-id)	ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	O nome do recurso
properties.customProperties	object	Propriedades personalizadas Os metadados personalizados definidos para entidades de catálogo de API.
properties.definitionId	string	ID do recurso de definição no escopo central da API.
properties.description	string maxLength: 500	Descrição da implantação.
properties.environmentId	string	ID do recurso de ambiente com escopo central da API.
properties.server	DeploymentServer	O servidor de implantação
properties.state	DeploymentState	Estado da implantação da API.
properties.title	string minLength: 1 maxLength: 50	Título da implantação da API
systemData	systemData	Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

DeploymentServer

Objeto

Servidor

Nome	Tipo	Description
runtimeUri	string[] (uri) maxLength: 200	URLs de runtime base para essa implantação.

DeploymentState

Enumeração

Estado da implantação

Valor	Description
active	Estado Ativo
inactive	Estado inativo

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

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

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
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

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.