Partager via

Service Microsoft.ApiManagement/locataire 2023-09-01-preview

  • Article

Définition de ressource Bicep

Le type de ressource de service/locataire 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.ApiManagement/service/locataire, ajoutez le bicep suivant à votre modèle.

resource symbolicname 'Microsoft.ApiManagement/service/tenant@2023-09-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    enabled: bool
    primaryKey: 'string'
    principalId: 'string'
    secondaryKey: 'string'
  }
}

Valeurs de propriété

service/locataire

Nom Description Valeur
nom Nom de la ressource

Découvrez comment définir des noms et des types pour les ressources enfants dans Bicep.		 chaîne (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 : service
Propriétés Les informations d’accès au locataire mettent à jour les propriétés des paramètres. AccessInformationCreateParameterPropertiesOrAccessIn...

AccessInformationCreateParameterPropertiesOrAccessIn...

Nom Description Valeur
Activé Détermine si l’accès direct est activé. Bool
primaryKey Clé d’accès primaire. Cette propriété ne sera pas remplie sur les opérations « GET » ! Utilisez la requête POST « /listSecrets » pour obtenir la valeur. corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.
principalId Identificateur principal (utilisateur). corde
secondaryKey Clé d’accès secondaire. Cette propriété ne sera pas remplie sur les opérations « GET » ! Utilisez la requête POST « /listSecrets » pour obtenir la valeur. corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.

Définition de ressource de modèle ARM

Le type de ressource de service/locataire 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.ApiManagement/service/locataire, ajoutez le code JSON suivant à votre modèle.

{
  "type": "Microsoft.ApiManagement/service/tenant",
  "apiVersion": "2023-09-01-preview",
  "name": "string",
  "properties": {
    "enabled": "bool",
    "primaryKey": "string",
    "principalId": "string",
    "secondaryKey": "string"
  }
}

Valeurs de propriété

service/locataire

Nom Description Valeur
type Type de ressource 'Microsoft.ApiManagement/service/tenant'
apiVersion Version de l’API de ressource '2023-09-01-preview'
nom Nom de la ressource

Découvrez comment définir des noms et des types pour les ressources enfants dans modèles ARM JSON.		 chaîne (obligatoire)
Propriétés Les informations d’accès au locataire mettent à jour les propriétés des paramètres. AccessInformationCreateParameterPropertiesOrAccessIn...

AccessInformationCreateParameterPropertiesOrAccessIn...

Nom Description Valeur
Activé Détermine si l’accès direct est activé. Bool
primaryKey Clé d’accès primaire. Cette propriété ne sera pas remplie sur les opérations « GET » ! Utilisez la requête POST « /listSecrets » pour obtenir la valeur. corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.
principalId Identificateur principal (utilisateur). corde
secondaryKey Clé d’accès secondaire. Cette propriété ne sera pas remplie sur les opérations « GET » ! Utilisez la requête POST « /listSecrets » pour obtenir la valeur. corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource de service/locataire 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.ApiManagement/service/locataire, ajoutez terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/tenant@2023-09-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      enabled = bool
      primaryKey = "string"
      principalId = "string"
      secondaryKey = "string"
    }
  })
}

Valeurs de propriété

service/locataire

Nom Description Valeur
type Type de ressource « Microsoft.ApiManagement/service/tenant@2023-09-01-preview »
nom Nom de la ressource chaîne (obligatoire)
parent_id ID de la ressource qui est le parent de cette ressource. ID de ressource de type : de service
Propriétés Les informations d’accès au locataire mettent à jour les propriétés des paramètres. AccessInformationCreateParameterPropertiesOrAccessIn...

AccessInformationCreateParameterPropertiesOrAccessIn...

Nom Description Valeur
Activé Détermine si l’accès direct est activé. Bool
primaryKey Clé d’accès primaire. Cette propriété ne sera pas remplie sur les opérations « GET » ! Utilisez la requête POST « /listSecrets » pour obtenir la valeur. corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.
principalId Identificateur principal (utilisateur). corde
secondaryKey Clé d’accès secondaire. Cette propriété ne sera pas remplie sur les opérations « GET » ! Utilisez la requête POST « /listSecrets » pour obtenir la valeur. corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.