Sdílet prostřednictvím

Služba Microsoft.ApiManagement / předplatná 2022-08-01

  • Článek

Definice prostředku Bicep

Typ prostředku služby nebo předplatného je možné nasadit s operacemi, 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/subscriptions, přidejte do šablony následující bicep.

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

Hodnoty vlastností

Microsoft.ApiManagement/service/subscriptions

Jméno Popis Hodnota
Jméno Název prostředku řetězec

Omezení:
Maximální délka =
Model = ^[^*#&+:<>?]+$ (povinné)
rodič V bicep můžete zadat nadřazený prostředek pro podřízený prostředek. Tuto vlastnost je potřeba 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: služby
vlastnosti Vlastnosti kontraktu předplatného SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties

SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties

Jméno Popis Hodnota
allowTracing Určuje, jestli je možné povolit trasování. Bool
displayName Název předplatného řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1 (povinné)
ownerId Uživatel (cesta ID uživatele), pro kterého se předplatné vytváří ve formuláři /users/{userId} řetězec
primaryKey Primární klíč předplatného. Pokud není zadán během klíče požadavku, vygeneruje se automaticky. řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1
rozsah Rozsah, například /products/{productId} nebo /apis nebo /apis/{apiId}. string (povinné)
secondaryKey Sekundární klíč předplatného. Pokud není zadán během klíče požadavku, vygeneruje se automaticky. řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1
stát Počáteční stav předplatného Pokud není zadána žádná hodnota, předplatné se vytvoří se stavem Odesláno. Možné stavy jsou * aktivní – předplatné je aktivní, * pozastaveno – předplatné je zablokované a odběratel nemůže volat žádná rozhraní API produktu, * odeslat – žádost o předplatné odeslal vývojář, ale ještě nebyla schválena nebo odmítnuta, * odmítnuta – žádost o předplatné byl zamítnut správcem, * zrušena – předplatné bylo zrušeno vývojářem nebo správcem, * Vypršela platnost – 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žby nebo předplatného je možné nasadit s operacemi, 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/subscriptions, přidejte do šablony následující JSON.

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

Hodnoty vlastností

Microsoft.ApiManagement/service/subscriptions

Jméno Popis Hodnota
apiVersion Verze rozhraní API '2022-08-01'
Jméno Název prostředku řetězec

Omezení:
Maximální délka =
Model = ^[^*#&+:<>?]+$ (povinné)
vlastnosti Vlastnosti kontraktu předplatného SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties
typ Typ prostředku Microsoft.ApiManagement/service/subscriptions

SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties

Jméno Popis Hodnota
allowTracing Určuje, jestli je možné povolit trasování. Bool
displayName Název předplatného řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1 (povinné)
ownerId Uživatel (cesta ID uživatele), pro kterého se předplatné vytváří ve formuláři /users/{userId} řetězec
primaryKey Primární klíč předplatného. Pokud není zadán během klíče požadavku, vygeneruje se automaticky. řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1
rozsah Rozsah, například /products/{productId} nebo /apis nebo /apis/{apiId}. string (povinné)
secondaryKey Sekundární klíč předplatného. Pokud není zadán během klíče požadavku, vygeneruje se automaticky. řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1
stát Počáteční stav předplatného Pokud není zadána žádná hodnota, předplatné se vytvoří se stavem Odesláno. Možné stavy jsou * aktivní – předplatné je aktivní, * pozastaveno – předplatné je zablokované a odběratel nemůže volat žádná rozhraní API produktu, * odeslat – žádost o předplatné odeslal vývojář, ale ještě nebyla schválena nebo odmítnuta, * odmítnuta – žádost o předplatné byl zamítnut správcem, * zrušena – předplatné bylo zrušeno vývojářem nebo správcem, * Vypršela platnost – 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 (poskytovatel AzAPI)

Typ prostředku služby nebo předplatného je možné nasadit s operacemi, 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/subscriptions, přidejte do šablony následující Terraform.

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

Hodnoty vlastností

Microsoft.ApiManagement/service/subscriptions

Jméno Popis Hodnota
Jméno Název prostředku řetězec

Omezení:
Maximální délka =
Model = ^[^*#&+:<>?]+$ (povinné)
parent_id ID prostředku, který je nadřazený pro tento prostředek. ID prostředku typu: služby
vlastnosti Vlastnosti kontraktu předplatného SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties
typ Typ prostředku Microsoft.ApiManagement/service/subscriptions@2022-08-01

SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties

Jméno Popis Hodnota
allowTracing Určuje, jestli je možné povolit trasování. Bool
displayName Název předplatného řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1 (povinné)
ownerId Uživatel (cesta ID uživatele), pro kterého se předplatné vytváří ve formuláři /users/{userId} řetězec
primaryKey Primární klíč předplatného. Pokud není zadán během klíče požadavku, vygeneruje se automaticky. řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1
rozsah Rozsah, například /products/{productId} nebo /apis nebo /apis/{apiId}. string (povinné)
secondaryKey Sekundární klíč předplatného. Pokud není zadán během klíče požadavku, vygeneruje se automaticky. řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1
stát Počáteční stav předplatného Pokud není zadána žádná hodnota, předplatné se vytvoří se stavem Odesláno. Možné stavy jsou * aktivní – předplatné je aktivní, * pozastaveno – předplatné je zablokované a odběratel nemůže volat žádná rozhraní API produktu, * odeslat – žádost o předplatné odeslal vývojář, ale ještě nebyla schválena nebo odmítnuta, * odmítnuta – žádost o předplatné byl zamítnut správcem, * zrušena – předplatné bylo zrušeno vývojářem nebo správcem, * Vypršela platnost – předplatné dosáhlo data vypršení platnosti a bylo deaktivováno. Aktivní
Zrušeno
Vypršela platnost.
"odmítnuto"
"odesláno"
"pozastaveno"