Microsoft.ApiManagement service/workspaces/subscriptions 2022-09-01-preview
Bicep-resursdefinition
Resurstypen tjänst/arbetsytor/prenumerationer kan distribueras med åtgärder som mål:
- Resursgrupper – Se distributionskommandon för 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/workspaces/subscriptions lägger du till följande Bicep i mallen.
resource symbolicname 'Microsoft.ApiManagement/service/workspaces/subscriptions@2022-09-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
allowTracing: bool
displayName: 'string'
ownerId: 'string'
primaryKey: 'string'
scope: 'string'
secondaryKey: 'string'
state: 'string'
}
}
Egenskapsvärden
service/workspaces/subscriptions
| Name | Beskrivning | Värde |
|---|---|---|
| name | Resursnamnet Se hur du anger namn och typer för underordnade resurser i Bicep. |
sträng (krävs) |
| 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: arbetsytor |
| 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 (sökväg till användar-ID) för vilken prenumerationen skapas i formulär /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 Skickad. 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 har nått utgångsdatumet och inaktiverats. | "aktiv" "avbröts" "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 distributionskommandon för 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/workspaces/subscriptions lägger du till följande JSON i mallen.
{
"type": "Microsoft.ApiManagement/service/workspaces/subscriptions",
"apiVersion": "2022-09-01-preview",
"name": "string",
"properties": {
"allowTracing": "bool",
"displayName": "string",
"ownerId": "string",
"primaryKey": "string",
"scope": "string",
"secondaryKey": "string",
"state": "string"
}
}
Egenskapsvärden
service/workspaces/subscriptions
| Name | Beskrivning | Värde |
|---|---|---|
| typ | Resurstypen | "Microsoft.ApiManagement/service/workspaces/subscriptions" |
| apiVersion | Resurs-API-versionen | "2022-09-01-preview" |
| name | Resursnamnet Se hur du anger namn och typer för underordnade resurser i JSON ARM-mallar. |
sträng (krävs) |
| 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" |
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 resurs för Microsoft.ApiManagement/service/workspaces/subscriptions lägger du till följande Terraform i mallen.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/workspaces/subscriptions@2022-09-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/arbetsytor/prenumerationer
| Name | Beskrivning | Värde |
|---|---|---|
| typ | Resurstypen | "Microsoft.ApiManagement/service/workspaces/subscriptions@2022-09-01-preview" |
| name | Resursnamnet | sträng (krävs) |
| parent_id | ID för resursen som är överordnad för den här resursen. | ID för resurs av typen: arbetsytor |
| 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" |