Microsoft.ApiManagement service/workspaces/subscriptions 2024-05-01
Bicep-resursdefinition
Resurstypen tjänst/arbetsytor/prenumerationer kan distribueras med åtgärder som mål:
- Resursgrupper – Se resursgruppsdistributionskommandon
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.ApiManagement/service/workspaces/subscriptions-resurs lägger du till följande Bicep i mallen.
resource symbolicname 'Microsoft.ApiManagement/service/workspaces/subscriptions@2024-05-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
allowTracing: bool
displayName: 'string'
ownerId: 'string'
primaryKey: 'string'
scope: 'string'
secondaryKey: 'string'
state: 'string'
}
}
Egenskapsvärden
Microsoft.ApiManagement/service/workspaces/subscriptions
| Namn | Beskrivning | Värde |
|---|---|---|
| Namn | Resursnamnet | sträng Begränsningar: Max längd = Mönster = ^[^*#&+:<>?]+$ (krävs) |
| 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/arbetsytor |
| Egenskaper | Egenskaper för prenumerationskontrakt. | SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties |
PrenumerationSkapaParameterEgenskaperOrSubscriptionContractProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| allowTracing | Avgör om spårning kan aktiveras | Bool |
| displayName | Prenumerationsnamn. | sträng Begränsningar: Min längd = 1 Maximal längd = 1 (krävs) |
| 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 Maximal längd = 1 |
| 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 Maximal längd = 1 |
| 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" |
Resursdefinition för ARM-mall
Resurstypen tjänst/arbetsytor/prenumerationer kan distribueras med åtgärder som mål:
- Resursgrupper – Se resursgruppsdistributionskommandon
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Resurs för Microsoft.ApiManagement/service/workspaces/subscriptions lägger du till följande JSON i mallen.
{
"type": "Microsoft.ApiManagement/service/workspaces/subscriptions",
"apiVersion": "2024-05-01",
"name": "string",
"properties": {
"allowTracing": "bool",
"displayName": "string",
"ownerId": "string",
"primaryKey": "string",
"scope": "string",
"secondaryKey": "string",
"state": "string"
}
}
Egenskapsvärden
Microsoft.ApiManagement/service/workspaces/subscriptions
| Namn | Beskrivning | Värde |
|---|---|---|
| apiVersion | API-versionen | '2024-05-01' |
| Namn | Resursnamnet | sträng Begränsningar: Max längd = Mönster = ^[^*#&+:<>?]+$ (krävs) |
| Egenskaper | Egenskaper för prenumerationskontrakt. | SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties |
| typ | Resurstypen | "Microsoft.ApiManagement/service/workspaces/subscriptions" |
PrenumerationSkapaParameterEgenskaperOrSubscriptionContractProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| allowTracing | Avgör om spårning kan aktiveras | Bool |
| displayName | Prenumerationsnamn. | sträng Begränsningar: Min längd = 1 Maximal längd = 1 (krävs) |
| 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 Maximal längd = 1 |
| 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 Maximal längd = 1 |
| 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" |
Resursdefinition för Terraform (AzAPI-provider)
Resurstypen tjänst/arbetsytor/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 Microsoft.ApiManagement/service/workspaces/subscriptions-resurs lägger du till följande Terraform i mallen.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/workspaces/subscriptions@2024-05-01"
name = "string"
body = jsonencode({
properties = {
allowTracing = bool
displayName = "string"
ownerId = "string"
primaryKey = "string"
scope = "string"
secondaryKey = "string"
state = "string"
}
})
}
Egenskapsvärden
Microsoft.ApiManagement/service/workspaces/subscriptions
| Namn | Beskrivning | Värde |
|---|---|---|
| Namn | Resursnamnet | sträng Begränsningar: Max längd = Mönster = ^[^*#&+:<>?]+$ (krävs) |
| parent_id | ID för resursen som är överordnad för den här resursen. | ID för resurs av typen: tjänst/arbetsytor |
| Egenskaper | Egenskaper för prenumerationskontrakt. | SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties |
| typ | Resurstypen | "Microsoft.ApiManagement/service/workspaces/subscriptions@2024-05-01" |
PrenumerationSkapaParameterEgenskaperOrSubscriptionContractProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| allowTracing | Avgör om spårning kan aktiveras | Bool |
| displayName | Prenumerationsnamn. | sträng Begränsningar: Min längd = 1 Maximal längd = 1 (krävs) |
| 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 Maximal längd = 1 |
| 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 Maximal längd = 1 |
| 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" |