Microsoft.ApiManagement-tjänst/prenumerationer 2023-03-01-preview
Bicep-resursdefinition
Resurstypen tjänst/prenumerationer kan distribueras med åtgärder som mål:
- Resursgrupper – Se kommandon för resursgruppsdistribution
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Resurs för Microsoft.ApiManagement/service/subscriptions lägger du till följande Bicep i mallen.
resource symbolicname 'Microsoft.ApiManagement/service/subscriptions@2023-03-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
allowTracing: bool
displayName: 'string'
ownerId: 'string'
primaryKey: 'string'
scope: 'string'
secondaryKey: 'string'
state: 'string'
}
}
Egenskapsvärden
tjänst/prenumerationer
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 prenumerationskontrakt. | SubscriptionCreateParameterPropertiesOrSubscriptionC... |
SubscriptionCreateParameterPropertiesOrSubscriptionC...
Name | Beskrivning | Värde |
---|---|---|
allowTracing | Avgör om spårning kan aktiveras | boolesk |
displayName | Prenumerationsnamn. | sträng (krävs) |
ownerId | Användare (användar-ID-sökväg) för vilken prenumerationen skapas i formatet /users/{userId} | sträng |
primaryKey | Primär prenumerationsnyckel. Om det inte anges under begäran genereras nyckeln automatiskt. | sträng |
omfång | Omfång som /products/{productId} eller /apis eller /apis/{apiId}. | sträng (krävs) |
secondaryKey | Sekundär prenumerationsnyckel. Om det inte anges under begäran genereras nyckeln automatiskt. | sträng |
state | 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, * har skickats – 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 har nått sitt utgångsdatum och inaktiverats. | "aktiv" "avbruten" "Har upphört att gälla" "avvisad" "skickat" "pausad" |
Snabbstartsmallar
Följande snabbstartsmallar distribuerar den här resurstypen.
Mall | Description |
---|---|
Skapa en API Management-instans och alla underresurser med hjälp av mallen |
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 mål:
- Resursgrupper – Se kommandon för resursgruppsdistribution
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Resurs för Microsoft.ApiManagement/service/subscriptions lägger du till följande JSON i mallen.
{
"type": "Microsoft.ApiManagement/service/subscriptions",
"apiVersion": "2023-03-01-preview",
"name": "string",
"properties": {
"allowTracing": "bool",
"displayName": "string",
"ownerId": "string",
"primaryKey": "string",
"scope": "string",
"secondaryKey": "string",
"state": "string"
}
}
Egenskapsvärden
tjänst/prenumerationer
Name | Beskrivning | Värde |
---|---|---|
typ | Resurstypen | "Microsoft.ApiManagement/service/subscriptions" |
apiVersion | Resurs-API-versionen | "2023-03-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 prenumerationskontrakt. | SubscriptionCreateParameterPropertiesOrSubscriptionC... |
SubscriptionCreateParameterPropertiesOrSubscriptionC...
Name | Beskrivning | Värde |
---|---|---|
allowTracing | Avgör om spårning kan aktiveras | boolesk |
displayName | Prenumerationsnamn. | sträng (krävs) |
ownerId | Användare (användar-ID-sökväg) för vilken prenumerationen skapas i formatet /users/{userId} | sträng |
primaryKey | Primär prenumerationsnyckel. Om det inte anges under begäran genereras nyckeln automatiskt. | sträng |
omfång | Omfång som /products/{productId} eller /apis eller /apis/{apiId}. | sträng (krävs) |
secondaryKey | Sekundär prenumerationsnyckel. Om det inte anges under begäran genereras nyckeln automatiskt. | sträng |
state | 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, * har skickats – 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 har nått sitt utgångsdatum och inaktiverats. | "aktiv" "avbruten" "Har upphört att gälla" "avvisad" "skickat" "pausad" |
Snabbstartsmallar
Följande snabbstartsmallar distribuerar den här resurstypen.
Mall | Description |
---|---|
Skapa en API Management-instans och alla underresurser med hjälp av mallen |
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 mål:
- Resursgrupper
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Resurs för Microsoft.ApiManagement/service/subscriptions lägger du till följande Terraform i mallen.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/subscriptions@2023-03-01-preview"
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
Name | Beskrivning | Värde |
---|---|---|
typ | Resurstypen | "Microsoft.ApiManagement/service/subscriptions@2023-03-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 för resursen som är överordnad för den här resursen. | ID för resurs av typen: tjänst |
properties | Egenskaper för prenumerationskontrakt. | SubscriptionCreateParameterPropertiesOrSubscriptionC... |
SubscriptionCreateParameterPropertiesOrSubscriptionC...
Name | Beskrivning | Värde |
---|---|---|
allowTracing | Avgör om spårning kan aktiveras | boolesk |
displayName | Prenumerationsnamn. | sträng (krävs) |
ownerId | Användare (användar-ID-sökväg) för vilken prenumerationen skapas i formatet /users/{userId} | sträng |
primaryKey | Primär prenumerationsnyckel. Om det inte anges under begäran genereras nyckeln automatiskt. | sträng |
omfång | Omfång som /products/{productId} eller /apis eller /apis/{apiId}. | sträng (krävs) |
secondaryKey | Sekundär prenumerationsnyckel. Om det inte anges under begäran genereras nyckeln automatiskt. | sträng |
state | 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, * har skickats – 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 har nått sitt utgångsdatum och inaktiverats. | "aktiv" "avbruten" "Har upphört" "avvisad" "skickat" "pausad" |