Partager via

Services Microsoft.ApiCenter/workspaces/apis/deployments

  • Article

Définition de ressource Bicep

Le type de ressource services/espaces de travail/apis/déploiements peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.ApiCenter/services/workspaces/apis/deployments, ajoutez le bicep suivant à votre modèle.

resource symbolicname 'Microsoft.ApiCenter/services/workspaces/apis/deployments@2024-06-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    customProperties: any(...)
    definitionId: 'string'
    description: 'string'
    environmentId: 'string'
    server: {
      runtimeUri: [
        'string'
      ]
    }
    state: 'string'
    title: 'string'
  }
}

Valeurs de la propriété

DeploymentProperties

Nom Description Valeur
customProperties Métadonnées personnalisées définies pour les entités du catalogue d’API. quelconque
definitionId ID de ressource de définition au centre d’API. corde
description Description du déploiement. corde

Contraintes:
Longueur maximale = 500
environmentId ID de ressource d’environnement au centre d’API. corde
serveur Le serveur de déploiement DeploymentServer
état État du déploiement d’API. 'actif'
'inactif'
titre Titre du déploiement d’API corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 50

DeploymentServer

Nom Description Valeur
runtimeUri URL du runtime de base pour ce déploiement. corde

Contraintes:
Longueur maximale = 200[]

Microsoft.ApiCenter/services/workspaces/apis/deployments

Nom Description Valeur
nom Nom de la ressource corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 90
Modèle = ^[a-zA-Z0-9-]{3,90}$ (obligatoire)
parent Dans Bicep, vous pouvez spécifier la ressource parente d’une ressource enfant. Vous devez uniquement ajouter cette propriété lorsque la ressource enfant est déclarée en dehors de la ressource parente.

Pour plus d’informations, consultez ressource enfant en dehors de la ressource parente.		 Nom symbolique de la ressource de type : services/espaces de travail/apis
Propriétés Propriétés spécifiques à la ressource pour cette ressource. DeploymentProperties

Définition de ressource de modèle ARM

Le type de ressource services/espaces de travail/apis/déploiements peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.ApiCenter/services/workspaces/apis/deployments, ajoutez le code JSON suivant à votre modèle.

{
  "type": "Microsoft.ApiCenter/services/workspaces/apis/deployments",
  "apiVersion": "2024-06-01-preview",
  "name": "string",
  "properties": {
    "customProperties": {},
    "definitionId": "string",
    "description": "string",
    "environmentId": "string",
    "server": {
      "runtimeUri": [ "string" ]
    },
    "state": "string",
    "title": "string"
  }
}

Valeurs de la propriété

DeploymentProperties

Nom Description Valeur
customProperties Métadonnées personnalisées définies pour les entités du catalogue d’API. quelconque
definitionId ID de ressource de définition au centre d’API. corde
description Description du déploiement. corde

Contraintes:
Longueur maximale = 500
environmentId ID de ressource d’environnement au centre d’API. corde
serveur Le serveur de déploiement DeploymentServer
état État du déploiement d’API. 'actif'
'inactif'
titre Titre du déploiement d’API corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 50

DeploymentServer

Nom Description Valeur
runtimeUri URL du runtime de base pour ce déploiement. corde

Contraintes:
Longueur maximale = 200[]

Microsoft.ApiCenter/services/workspaces/apis/deployments

Nom Description Valeur
apiVersion Version de l’API '2024-06-01-preview'
nom Nom de la ressource corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 90
Modèle = ^[a-zA-Z0-9-]{3,90}$ (obligatoire)
Propriétés Propriétés spécifiques à la ressource pour cette ressource. DeploymentProperties
type Type de ressource 'Microsoft.ApiCenter/services/workspaces/apis/deployments'

Exemples d’utilisation

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource services/espaces de travail/apis/déploiements peut être déployé avec des opérations qui ciblent :

  • groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.ApiCenter/services/workspaces/apis/deployments, ajoutez terraform suivante à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiCenter/services/workspaces/apis/deployments@2024-06-01-preview"
  name = "string"
  body = {
    properties = {
      customProperties = ?
      definitionId = "string"
      description = "string"
      environmentId = "string"
      server = {
        runtimeUri = [
          "string"
        ]
      }
      state = "string"
      title = "string"
    }
  }
}

Valeurs de la propriété

DeploymentProperties

Nom Description Valeur
customProperties Métadonnées personnalisées définies pour les entités du catalogue d’API. quelconque
definitionId ID de ressource de définition au centre d’API. corde
description Description du déploiement. corde

Contraintes:
Longueur maximale = 500
environmentId ID de ressource d’environnement au centre d’API. corde
serveur Le serveur de déploiement DeploymentServer
état État du déploiement d’API. 'actif'
'inactif'
titre Titre du déploiement d’API corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 50

DeploymentServer

Nom Description Valeur
runtimeUri URL du runtime de base pour ce déploiement. corde

Contraintes:
Longueur maximale = 200[]

Microsoft.ApiCenter/services/workspaces/apis/deployments

Nom Description Valeur
nom Nom de la ressource corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 90
Modèle = ^[a-zA-Z0-9-]{3,90}$ (obligatoire)
parent_id ID de la ressource qui est le parent de cette ressource. ID de ressource de type : services/espaces de travail/apis
Propriétés Propriétés spécifiques à la ressource pour cette ressource. DeploymentProperties
type Type de ressource « Microsoft.ApiCenter/services/workspaces/apis/deployments@2024-06-01-preview »