Dela via

Microsoft.ApiManagement service/subscriptions 2021-08-01

  • Artikel

Bicep-resursdefinition

Resurstypen tjänst/prenumerationer kan distribueras med åtgärder som är avsedda för:

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

Resursformat

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

resource symbolicname 'Microsoft.ApiManagement/service/subscriptions@2021-08-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    allowTracing: bool
    displayName: 'string'
    ownerId: 'string'
    primaryKey: 'string'
    scope: 'string'
    secondaryKey: 'string'
    state: 'string'
  }
}

Egenskapsvärden

tjänst/prenumerationer

Namn Beskrivning Värde
Namn 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.
förälder 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 den överordnade resursen.		 Symboliskt namn för resurs av typen: tjänst
Egenskaper Egenskaper för prenumerationskontrakt. SubscriptionCreateParameterPropertiesOrSubscriptionC...

SubscriptionCreateParameterPropertiesOrSubscriptionC...

Namn Beskrivning Värde
allowTracing Avgör om spårning kan aktiveras Bool
displayName Prenumerationsnamn. sträng (krävs)

Begränsningar:
Min längd = 1
Maxlängd = 100
ownerId Användare (sökväg för användar-ID) för vilken prenumerationen skapas i formuläret /users/{userId} sträng
primaryKey Primär prenumerationsnyckel. Om den inte anges under begäran genereras nyckeln automatiskt. sträng

Begränsningar:
Min längd = 1
Max längd = 256
omfattning Omfång som /products/{productId} eller /apis eller /apis/{apiId}. sträng (krävs)
secondaryKey Sekundär prenumerationsnyckel. Om den inte anges under begäran genereras nyckeln automatiskt. sträng

Begränsningar:
Min längd = 1
Max längd = 256
stat Ursprungligt prenumerationstillstånd. Om inget värde anges skapas prenumerationen med tillståndet Skickat. Möjliga tillstånd är * aktiva – prenumerationen är aktiv, * pausad – prenumerationen blockeras och prenumeranten kan inte anropa några API:er för produkten, * skickad – prenumerationsbegäran har gjorts av utvecklaren, men har ännu inte godkänts eller avvisats, * avvisats – prenumerationsbegäran har nekats av en administratör, * avbrutits – prenumerationen har avbrutits av utvecklaren eller administratören. * har upphört att gälla – prenumerationen nådde sitt utgångsdatum och inaktiverades. "aktiv"
"avbruten"
"har upphört att gälla"
"avvisad"
"skickat"
"pausad"

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

Mall Beskrivning
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

Resursdefinition för ARM-mall

Resurstypen tjänst/prenumerationer kan distribueras med åtgärder som är avsedda för:

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

Resursformat

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

{
  "type": "Microsoft.ApiManagement/service/subscriptions",
  "apiVersion": "2021-08-01",
  "name": "string",
  "properties": {
    "allowTracing": "bool",
    "displayName": "string",
    "ownerId": "string",
    "primaryKey": "string",
    "scope": "string",
    "secondaryKey": "string",
    "state": "string"
  }
}

Egenskapsvärden

tjänst/prenumerationer

Namn Beskrivning Värde
typ Resurstypen "Microsoft.ApiManagement/service/subscriptions"
apiVersion Resurs-API-versionen '2021-08-01'
Namn 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.
Egenskaper Egenskaper för prenumerationskontrakt. SubscriptionCreateParameterPropertiesOrSubscriptionC...

SubscriptionCreateParameterPropertiesOrSubscriptionC...

Namn Beskrivning Värde
allowTracing Avgör om spårning kan aktiveras Bool
displayName Prenumerationsnamn. sträng (krävs)

Begränsningar:
Min längd = 1
Maxlängd = 100
ownerId Användare (sökväg för användar-ID) för vilken prenumerationen skapas i formuläret /users/{userId} sträng
primaryKey Primär prenumerationsnyckel. Om den inte anges under begäran genereras nyckeln automatiskt. sträng

Begränsningar:
Min längd = 1
Max längd = 256
omfattning Omfång som /products/{productId} eller /apis eller /apis/{apiId}. sträng (krävs)
secondaryKey Sekundär prenumerationsnyckel. Om den inte anges under begäran genereras nyckeln automatiskt. sträng

Begränsningar:
Min längd = 1
Max längd = 256
stat Ursprungligt prenumerationstillstånd. Om inget värde anges skapas prenumerationen med tillståndet Skickat. Möjliga tillstånd är * aktiva – prenumerationen är aktiv, * pausad – prenumerationen blockeras och prenumeranten kan inte anropa några API:er för produkten, * skickad – prenumerationsbegäran har gjorts av utvecklaren, men har ännu inte godkänts eller avvisats, * avvisats – prenumerationsbegäran har nekats av en administratör, * avbrutits – prenumerationen har avbrutits av utvecklaren eller administratören. * har upphört att gälla – prenumerationen nådde sitt utgångsdatum och inaktiverades. "aktiv"
"avbruten"
"har upphört att gälla"
"avvisad"
"skickat"
"pausad"

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

Mall Beskrivning
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

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen tjänst/prenumerationer kan distribueras med åtgärder som är avsedda för:

  • Resursgrupper

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

Resursformat

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/subscriptions@2021-08-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      allowTracing = bool
      displayName = "string"
      ownerId = "string"
      primaryKey = "string"
      scope = "string"
      secondaryKey = "string"
      state = "string"
    }
  })
}

Egenskapsvärden

tjänst/prenumerationer

Namn Beskrivning Värde
typ Resurstypen "Microsoft.ApiManagement/service/subscriptions@2021-08-01"
Namn 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 för resursen som är överordnad för den här resursen. ID för resurs av typen: tjänst
Egenskaper Egenskaper för prenumerationskontrakt. SubscriptionCreateParameterPropertiesOrSubscriptionC...

SubscriptionCreateParameterPropertiesOrSubscriptionC...

Namn Beskrivning Värde
allowTracing Avgör om spårning kan aktiveras Bool
displayName Prenumerationsnamn. sträng (krävs)

Begränsningar:
Min längd = 1
Maxlängd = 100
ownerId Användare (sökväg för användar-ID) för vilken prenumerationen skapas i formuläret /users/{userId} sträng
primaryKey Primär prenumerationsnyckel. Om den inte anges under begäran genereras nyckeln automatiskt. sträng

Begränsningar:
Min längd = 1
Max längd = 256
omfattning Omfång som /products/{productId} eller /apis eller /apis/{apiId}. sträng (krävs)
secondaryKey Sekundär prenumerationsnyckel. Om den inte anges under begäran genereras nyckeln automatiskt. sträng

Begränsningar:
Min längd = 1
Max längd = 256
stat Ursprungligt prenumerationstillstånd. Om inget värde anges skapas prenumerationen med tillståndet Skickat. Möjliga tillstånd är * aktiva – prenumerationen är aktiv, * pausad – prenumerationen blockeras och prenumeranten kan inte anropa några API:er för produkten, * skickad – prenumerationsbegäran har gjorts av utvecklaren, men har ännu inte godkänts eller avvisats, * avvisats – prenumerationsbegäran har nekats av en administratör, * avbrutits – prenumerationen har avbrutits av utvecklaren eller administratören. * har upphört att gälla – prenumerationen nådde sitt utgångsdatum och inaktiverades. "aktiv"
"avbröts"
"har upphört att gälla"
"avvisad"
"skickat"
"pausad"