Microsoft.ApiManagement-Dienst/Produkte/Richtlinien 2024-06-01-preview

Bicep-Ressourcendefinition

Der Ressourcentyp "Service/products/policies" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Verwendungsbeispiele

Bicep-Beispiele

Ein grundlegendes Beispiel für die Bereitstellung von API Management-Dienstproduktrichtlinien.

param resourceName string = 'acctest0001'
param location string = 'westeurope'

resource service 'Microsoft.ApiManagement/service@2021-08-01' = {
  name: resourceName
  location: location
  sku: {
    capacity: 0
    name: 'Consumption'
  }
  properties: {
    certificates: []
    customProperties: {
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11': 'false'
    }
    disableGateway: false
    publicNetworkAccess: 'Enabled'
    publisherEmail: 'pub1@email.com'
    publisherName: 'pub1'
    virtualNetworkType: 'None'
  }
}

resource product 'Microsoft.ApiManagement/service/products@2021-08-01' = {
  name: resourceName
  parent: service
  properties: {
    description: ''
    displayName: 'Test Product'
    state: 'notPublished'
    subscriptionRequired: false
    terms: ''
  }
}

resource policy2 'Microsoft.ApiManagement/service/products/policies@2021-08-01' = {
  name: 'policy'
  parent: product
  properties: {
    format: 'rawxml-link'
    value: 'https://gist.githubusercontent.com/riordanp/ca22f8113afae0eb38cc12d718fd048d/raw/d6ac89a2f35a6881a7729f8cb4883179dc88eea1/example.xml'
  }
}

Von Azure verifizierte Module

Die folgenden Azure Verified Modules können verwendet werden, um diesen Ressourcentyp bereitzustellen.

Module Beschreibung
API-Management-Service – Produkt – Richtlinie AVM Child Module für API-Management-Dienst – Produkt – Richtlinie

Ressourcenformat

Um eine Microsoft.ApiManagement/service/products/policies-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Bicep hinzu.

resource symbolicname 'Microsoft.ApiManagement/service/products/policies@2024-06-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    format: 'string'
    value: 'string'
  }
}

Eigenschaftswerte

Microsoft.ApiManagement/service/products/policies

Name Beschreibung Wert
Name Der Ressourcenname "Richtlinie" (erforderlich)
Elternteil In Bicep können Sie die übergeordnete Ressource für eine untergeordnete Ressource angeben. Sie müssen diese Eigenschaft nur hinzufügen, wenn die untergeordnete Ressource außerhalb der übergeordneten Ressource deklariert wird.

Weitere Informationen finden Sie unter Untergeordnete Ressource außerhalb der übergeordneten Ressource.
Symbolischer Name für Die Ressource des Typs: Service/Produkte
Eigenschaften Eigenschaften der Richtlinie. PolicyContractProperties-

PolicyContractProperties

Name Beschreibung Wert
Format Format der policyContent. "rawxml"
"rawxml-link"
'xml'
'xml-link'
Wert Inhalt der Richtlinie gemäß definition des Formats. Zeichenfolge (erforderlich)

ARM-Vorlagenressourcendefinition

Der Ressourcentyp "Service/products/policies" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Verwendungsbeispiele

Ressourcenformat

Um eine Microsoft.ApiManagement/service/products/policies-Ressource zu erstellen, fügen Sie Der Vorlage den folgenden JSON-Code hinzu.

{
  "type": "Microsoft.ApiManagement/service/products/policies",
  "apiVersion": "2024-06-01-preview",
  "name": "string",
  "properties": {
    "format": "string",
    "value": "string"
  }
}

Eigenschaftswerte

Microsoft.ApiManagement/service/products/policies

Name Beschreibung Wert
apiVersion Die API-Version "2024-06-01-preview"
Name Der Ressourcenname "Richtlinie" (erforderlich)
Eigenschaften Eigenschaften der Richtlinie. PolicyContractProperties-
Art Der Ressourcentyp "Microsoft.ApiManagement/service/products/policies"

PolicyContractProperties

Name Beschreibung Wert
Format Format der policyContent. "rawxml"
"rawxml-link"
'xml'
'xml-link'
Wert Inhalt der Richtlinie gemäß definition des Formats. Zeichenfolge (erforderlich)

Terraform -Ressourcendefinition (AzAPI-Anbieter)

Der Ressourcentyp "Service/products/policies" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

  • Ressourcengruppen Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Change Log.

Verwendungsbeispiele

Terraform-Beispiele

Ein grundlegendes Beispiel für die Bereitstellung von API Management-Dienstproduktrichtlinien.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "service" {
  type      = "Microsoft.ApiManagement/service@2021-08-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      certificates = [
      ]
      customProperties = {
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30" = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10" = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11" = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10"         = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11"         = "false"
      }
      disableGateway      = false
      publicNetworkAccess = "Enabled"
      publisherEmail      = "pub1@email.com"
      publisherName       = "pub1"
      virtualNetworkType  = "None"
    }
    sku = {
      capacity = 0
      name     = "Consumption"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "product" {
  type      = "Microsoft.ApiManagement/service/products@2021-08-01"
  parent_id = azapi_resource.service.id
  name      = var.resource_name
  body = {
    properties = {
      description          = ""
      displayName          = "Test Product"
      state                = "notPublished"
      subscriptionRequired = false
      terms                = ""
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "policy2" {
  type      = "Microsoft.ApiManagement/service/products/policies@2021-08-01"
  parent_id = azapi_resource.product.id
  name      = "policy"
  body = {
    properties = {
      format = "rawxml-link"
      value  = "https://gist.githubusercontent.com/riordanp/ca22f8113afae0eb38cc12d718fd048d/raw/d6ac89a2f35a6881a7729f8cb4883179dc88eea1/example.xml"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

Ressourcenformat

Um eine Ressource "Microsoft.ApiManagement/service/products/policies" zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/products/policies@2024-06-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      format = "string"
      value = "string"
    }
  }
}

Eigenschaftswerte

Microsoft.ApiManagement/service/products/policies

Name Beschreibung Wert
Name Der Ressourcenname "Richtlinie" (erforderlich)
parent_id Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. ID für Ressource des Typs: Service/Products
Eigenschaften Eigenschaften der Richtlinie. PolicyContractProperties-
Art Der Ressourcentyp "Microsoft.ApiManagement/service/products/policies@2024-06-01-preview"

PolicyContractProperties

Name Beschreibung Wert
Format Format der policyContent. "rawxml"
"rawxml-link"
'xml'
'xml-link'
Wert Inhalt der Richtlinie gemäß definition des Formats. Zeichenfolge (erforderlich)