Microsoft.ApiManagement service/products

  • Artikel

Bicep-resursdefinition

Resurstypen tjänst/produkter kan distribueras med åtgärder som är mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Resurs för Microsoft.ApiManagement/service/products lägger du till följande Bicep i mallen.

resource symbolicname 'Microsoft.ApiManagement/service/products@2023-05-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    approvalRequired: bool
    description: 'string'
    displayName: 'string'
    state: 'string'
    subscriptionRequired: bool
    subscriptionsLimit: int
    terms: 'string'
  }
}

Egenskapsvärden

tjänst/produkter

Name Beskrivning Värde
name Resursnamnet

Se hur du anger namn och typer för underordnade resurser i Bicep.		 sträng (krävs)

Teckengräns: 1–80

Giltiga tecken:
Alfanumeriska tecken och bindestreck.

Börja med bokstav och slut med alfanumeriskt.
parent I Bicep kan du ange den överordnade resursen för en underordnad resurs. Du behöver bara lägga till den här egenskapen när den underordnade resursen deklareras utanför den överordnade resursen.

Mer information finns i Underordnad resurs utanför överordnad resurs.		 Symboliskt namn för resurs av typen: tjänst
properties Egenskaper för produktentitetskontrakt. ProductContractProperties

ProductContractProperties

Name Beskrivning Värde
approvalRequired om prenumerationsgodkännande krävs. Om det är falskt godkänns nya prenumerationer automatiskt så att utvecklare kan anropa produktens API:er omedelbart efter prenumerationen. Om det är sant måste administratörer godkänna prenumerationen manuellt innan utvecklaren kan något av produktens API:er. Kan bara finnas om egenskapen subscriptionRequired finns och har värdet false. boolesk
beskrivning Produktbeskrivning. Kan innehålla HTML-formateringstaggar. sträng
displayName Produktnamn. sträng (krävs)
state om produkten har publicerats eller inte. Publicerade produkter kan identifieras av användare av utvecklarportalen. Icke-publicerade produkter är endast synliga för administratörer. Standardtillståndet för Produkt är intePublicerat. "notPublished"
"publicerad"
subscriptionRequired Om en produktprenumeration krävs för åtkomst till API:er som ingår i den här produkten. Om det är sant kallas produkten "skyddad" och en giltig prenumerationsnyckel krävs för att en begäran till ett API som ingår i produkten ska lyckas. Om det är falskt kallas produkten "öppen" och begäranden till ett API som ingår i produkten kan göras utan en prenumerationsnyckel. Om egenskapen utelämnas när en ny produkt skapas antas värdet vara sant. boolesk
subscriptionsLimit Om antalet prenumerationer som en användare kan ha på den här produkten samtidigt. Ange till null eller utelämna om du vill tillåta obegränsade prenumerationer per användare. Kan bara finnas om egenskapen subscriptionRequired finns och har värdet false. int
Villkor Användningsvillkor för produkten. Utvecklare som försöker prenumerera på produkten kommer att presenteras och måste godkänna dessa villkor innan de kan slutföra prenumerationsprocessen. sträng

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

Mall Description
Skapa en API Management-instans och alla underresurser med hjälp av mallen

Distribuera till Azure		 Den här mallen visar hur du skapar en API Management-tjänst och konfigurerar underentiteter
Skapa Azure Front Door framför Azure API Management

Distribuera till Azure		 Det här exemplet visar hur du använder Azure Front Door som global lastbalanserare framför Azure API Management.

Resursdefinition för ARM-mall

Resurstypen tjänst/produkter kan distribueras med åtgärder som är mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Resurs för Microsoft.ApiManagement/service/products lägger du till följande JSON i mallen.

{
  "type": "Microsoft.ApiManagement/service/products",
  "apiVersion": "2023-05-01-preview",
  "name": "string",
  "properties": {
    "approvalRequired": "bool",
    "description": "string",
    "displayName": "string",
    "state": "string",
    "subscriptionRequired": "bool",
    "subscriptionsLimit": "int",
    "terms": "string"
  }
}

Egenskapsvärden

tjänst/produkter

Name Beskrivning Värde
typ Resurstypen "Microsoft.ApiManagement/service/products"
apiVersion Resurs-API-versionen "2023-05-01-preview"
name Resursnamnet

Se hur du anger namn och typer för underordnade resurser i JSON ARM-mallar.		 sträng (krävs)

Teckengräns: 1–80

Giltiga tecken:
Alfanumeriska tecken och bindestreck.

Börja med bokstav och slut med alfanumeriskt.
properties Egenskaper för produktentitetskontrakt. ProductContractProperties

ProductContractProperties

Name Beskrivning Värde
approvalRequired om prenumerationsgodkännande krävs. Om det är falskt godkänns nya prenumerationer automatiskt så att utvecklare kan anropa produktens API:er omedelbart efter prenumerationen. Om det är sant måste administratörer godkänna prenumerationen manuellt innan utvecklaren kan någon av produktens API:er. Kan bara finnas om egenskapen subscriptionRequired finns och har värdet false. boolesk
beskrivning Produktbeskrivning. Kan innehålla HTML-formateringstaggar. sträng
displayName Produktnamn. sträng (krävs)
state om produkten publiceras eller inte. Publicerade produkter kan identifieras av användare av utvecklarportalen. Icke-publicerade produkter är endast synliga för administratörer. Standardtillståndet för Product är intePublicerat. "notPublished"
"publicerad"
subscriptionRequired Om en produktprenumeration krävs för åtkomst till API:er som ingår i den här produkten. Om det är sant kallas produkten "skyddad" och en giltig prenumerationsnyckel krävs för att en begäran till ett API som ingår i produkten ska lyckas. Om det är falskt kallas produkten "öppen" och begäranden till ett API som ingår i produkten kan göras utan en prenumerationsnyckel. Om egenskapen utelämnas när en ny produkt skapas antas värdet vara sant. boolesk
subscriptionsLimit Om antalet prenumerationer som en användare kan ha till den här produkten samtidigt. Ange till null eller utelämna om du vill tillåta obegränsade prenumerationer per användare. Kan bara finnas om egenskapen subscriptionRequired finns och har värdet false. int
Villkor Användningsvillkor för produkten. Utvecklare som försöker prenumerera på produkten kommer att presenteras och måste godkänna dessa villkor innan de kan slutföra prenumerationsprocessen. sträng

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

Mall Description
Skapa en API Management-instans och alla underresurser med hjälp av mallen

Distribuera till Azure		 Den här mallen visar hur du skapar en API Management-tjänst och konfigurerar underentiteter
Skapa Azure Front Door framför Azure API Management

Distribuera till Azure		 Det här exemplet visar hur du använder Azure Front Door som global lastbalanserare framför Azure API Management.

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen tjänst/produkter kan distribueras med åtgärder som mål:

  • Resursgrupper

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.ApiManagement/service/products-resurs lägger du till följande Terraform i mallen.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/products@2023-05-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      approvalRequired = bool
      description = "string"
      displayName = "string"
      state = "string"
      subscriptionRequired = bool
      subscriptionsLimit = int
      terms = "string"
    }
  })
}

Egenskapsvärden

service/products

Name Beskrivning Värde
typ Resurstypen "Microsoft.ApiManagement/service/products@2023-05-01-preview"
name Resursnamnet sträng (krävs)

Teckengräns: 1–80

Giltiga tecken:
Alfanumeriska tecken och bindestreck.

Börja med bokstav och slut med alfanumeriskt.
parent_id ID:t för resursen som är överordnad för den här resursen. ID för resurs av typen: tjänst
properties Egenskaper för produktentitetskontrakt. ProductContractProperties

ProductContractProperties

Name Beskrivning Värde
approvalRequired om prenumerationsgodkännande krävs. Om det är falskt godkänns nya prenumerationer automatiskt så att utvecklare kan anropa produktens API:er omedelbart efter prenumerationen. Om det är sant måste administratörer godkänna prenumerationen manuellt innan utvecklaren kan något av produktens API:er. Kan bara finnas om egenskapen subscriptionRequired finns och har värdet false. boolesk
beskrivning Produktbeskrivning. Kan innehålla HTML-formateringstaggar. sträng
displayName Produktnamn. sträng (krävs)
state om produkten har publicerats eller inte. Publicerade produkter kan identifieras av användare av utvecklarportalen. Icke-publicerade produkter är endast synliga för administratörer. Standardtillståndet för Produkt är intePublicerat. "notPublished"
"publicerad"
subscriptionRequired Om en produktprenumeration krävs för åtkomst till API:er som ingår i den här produkten. Om det är sant kallas produkten "skyddad" och en giltig prenumerationsnyckel krävs för att en begäran till ett API som ingår i produkten ska lyckas. Om det är falskt kallas produkten "öppen" och begäranden till ett API som ingår i produkten kan göras utan en prenumerationsnyckel. Om egenskapen utelämnas när en ny produkt skapas antas värdet vara sant. boolesk
subscriptionsLimit Om antalet prenumerationer som en användare kan ha på den här produkten samtidigt. Ange till null eller utelämna om du vill tillåta obegränsade prenumerationer per användare. Kan bara finnas om egenskapen subscriptionRequired finns och har värdet false. int
Villkor Användningsvillkor för produkten. Utvecklare som försöker prenumerera på produkten kommer att presenteras och måste godkänna dessa villkor innan de kan slutföra prenumerationsprocessen. sträng