Služba Microsoft.ApiManagement/workspaces/subscriptions

  • Článek

Definice prostředku Bicep

Typ prostředku služba, pracovní prostory nebo předplatná je možné nasadit s operacemi, na které cílí:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/workspaces/subscriptions, přidejte do šablony následující bicep.

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

Hodnoty vlastností

služba/pracovní prostory/předplatná

Název Description Hodnota
name Název prostředku

Přečtěte si, jak nastavit názvy a typy pro podřízené prostředky v Bicepu.		 string (povinné)
Nadřazené V nástroji Bicep můžete zadat nadřazený prostředek pro podřízený prostředek. Tuto vlastnost stačí přidat pouze v případě, že je podřízený prostředek deklarován mimo nadřazený prostředek.

Další informace najdete v tématu Podřízený prostředek mimo nadřazený prostředek.		 Symbolický název prostředku typu: pracovní prostory
properties Vlastnosti smlouvy o předplatném. SubscriptionCreateParameterPropertiesOrSubscriptionC...

SubscriptionCreateParameterPropertiesOrSubscriptionC...

Název Description Hodnota
allowTracing Určuje, jestli je možné povolit trasování. bool
displayName Název předplatného. string (povinné)
ownerId (ID vlastníka) Uživatel (cesta id uživatele), pro kterého se vytváří předplatné ve formátu /users/{userId} řetězec
primaryKey Primární klíč předplatného. Pokud není klíč požadavku zadán, vygeneruje se automaticky. řetězec
scope Rozsah, jako je /products/{productId} nebo /apis nebo /apis/{apiId}. string (povinné)
secondaryKey Sekundární klíč předplatného. Pokud není klíč požadavku zadán, vygeneruje se automaticky. řetězec
state Počáteční stav předplatného. Pokud není zadána žádná hodnota, vytvoří se předplatné se stavem Odesláno. Možné stavy jsou * aktivní – předplatné je aktivní, * pozastaveno – předplatné je zablokované a předplatitel nemůže volat žádná rozhraní API produktu, * odesláno – žádost o předplatné byla podána vývojářem, ale ještě nebyla schválena nebo zamítnuta, * zamítnuta – žádost o předplatné byla zamítnuta správcem, * zrušena – předplatné bylo zrušeno vývojářem nebo správcem, * Vypršela – předplatné dosáhlo data vypršení platnosti a bylo deaktivováno. Aktivní
"zrušeno"
Vypršela platnost
"odmítnuto"
"odesláno"
"pozastaveno"

Definice prostředku šablony ARM

Typ prostředku služba, pracovní prostory nebo předplatná je možné nasadit s operacemi, na které cílí:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/workspaces/subscriptions, přidejte do šablony následující kód JSON.

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

Hodnoty vlastností

služba/pracovní prostory/předplatná

Název Description Hodnota
typ Typ prostředku Microsoft.ApiManagement/service/workspaces/subscriptions
apiVersion Verze rozhraní API prostředků '2023-03-01-preview'
name Název prostředku

Podívejte se, jak nastavit názvy a typy pro podřízené prostředky v šablonách JSON ARM.		 string (povinné)
properties Vlastnosti smlouvy o předplatném. SubscriptionCreateParameterPropertiesOrSubscriptionC...

SubscriptionCreateParameterPropertiesOrSubscriptionC...

Název Description Hodnota
allowTracing Určuje, jestli je možné povolit trasování. bool
displayName Název předplatného. string (povinné)
ownerId (ID vlastníka) Uživatel (cesta id uživatele), pro kterého se vytváří předplatné ve formátu /users/{userId} řetězec
primaryKey Primární klíč předplatného. Pokud není klíč požadavku zadán, vygeneruje se automaticky. řetězec
scope Rozsah, jako je /products/{productId} nebo /apis nebo /apis/{apiId}. string (povinné)
secondaryKey Sekundární klíč předplatného. Pokud není klíč požadavku zadán, vygeneruje se automaticky. řetězec
state Počáteční stav předplatného. Pokud není zadána žádná hodnota, vytvoří se předplatné se stavem Odesláno. Možné stavy jsou * aktivní – předplatné je aktivní, * pozastaveno – předplatné je zablokované a předplatitel nemůže volat žádná rozhraní API produktu, * odesláno – žádost o předplatné byla podána vývojářem, ale ještě nebyla schválena nebo zamítnuta, * zamítnuta – žádost o předplatné byla zamítnuta správcem, * zrušena – předplatné bylo zrušeno vývojářem nebo správcem, * Vypršela – předplatné dosáhlo data vypršení platnosti a bylo deaktivováno. Aktivní
"zrušeno"
Vypršela platnost
"odmítnuto"
"odesláno"
"pozastaveno"

Definice prostředku Terraformu (zprostředkovatele AzAPI)

Typ prostředku služba, pracovní prostory nebo předplatná je možné nasadit s operacemi, na které cílí:

  • Skupiny prostředků

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/workspaces/subscriptions, přidejte do šablony následující Terraform.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/workspaces/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"
    }
  })
}

Hodnoty vlastností

služba/pracovní prostory/předplatná

Název Description Hodnota
typ Typ prostředku Microsoft.ApiManagement/service/workspaces/subscriptions@2023-03-01-preview
name Název prostředku string (povinné)
parent_id ID prostředku, který je nadřazený pro tento prostředek. ID prostředku typu: pracovní prostory
properties Vlastnosti smlouvy o předplatném. SubscriptionCreateParameterPropertiesOrSubscriptionC...

SubscriptionCreateParameterPropertiesOrSubscriptionC...

Název Description Hodnota
allowTracing Určuje, jestli je možné povolit trasování. bool
displayName Název předplatného. string (povinné)
ownerId (ID vlastníka) Uživatel (cesta id uživatele), pro kterého se vytváří předplatné ve formátu /users/{userId} řetězec
primaryKey Primární klíč předplatného. Pokud není klíč požadavku zadán, vygeneruje se automaticky. řetězec
scope Rozsah, jako je /products/{productId} nebo /apis nebo /apis/{apiId}. string (povinné)
secondaryKey Sekundární klíč předplatného. Pokud není klíč požadavku zadán, vygeneruje se automaticky. řetězec
state Počáteční stav předplatného. Pokud není zadána žádná hodnota, vytvoří se předplatné se stavem Odesláno. Možné stavy jsou * aktivní – předplatné je aktivní, * pozastaveno – předplatné je zablokované a předplatitel nemůže volat žádná rozhraní API produktu, * odesláno – žádost o předplatné byla podána vývojářem, ale ještě nebyla schválena nebo zamítnuta, * zamítnuta – žádost o předplatné byla zamítnuta správcem, * zrušena – předplatné bylo zrušeno vývojářem nebo správcem, * Vypršela – předplatné dosáhlo data vypršení platnosti a bylo deaktivováno. "aktivní"
"zrušeno"
"expired"
"odmítnuto"
"odesláno"
"pozastaveno"