Microsoft.ApiManagement-service/werkruimten/abonnementen

• meest recente
• 2024-06-01-preview
• 2024-05-01
• 2023-09-01-preview
• 2023-05-01-preview-
• 2023-03-01-preview-
• 2022-09-01-preview-

Bicep-resourcedefinitie

Het resourcetype service/werkruimten/abonnementen kan worden geïmplementeerd met bewerkingen die zijn gericht op:

• Resourcegroepen - Zie opdrachten voor de implementatie van resourcegroepen

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een resource voor Microsoft.ApiManagement/service/werkruimten/abonnementen wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.

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

Eigenschapswaarden

Microsoft.ApiManagement/service/workspaces/subscriptions

Naam	Beschrijving	Waarde
naam	De resourcenaam	snaar Beperkingen: Maximale lengte = Patroon = ^[^*#&+:<>?]+$ (vereist)
ouder	In Bicep kunt u de bovenliggende resource voor een onderliggende resource opgeven. U hoeft deze eigenschap alleen toe te voegen wanneer de onderliggende resource buiten de bovenliggende resource wordt gedeclareerd. Zie onderliggende resource buiten de bovenliggende resourcevoor meer informatie.	Symbolische naam voor resource van het type: service/werkruimten
Eigenschappen	Eigenschappen van abonnementscontract.	SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties

SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties

Naam	Beschrijving	Waarde
allowTracing	Bepaalt of tracering kan worden ingeschakeld	Bool
displayName	Abonnementsnaam.	snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 1 (vereist)
ownerId	Gebruiker (gebruikers-id-pad) voor wie het abonnement wordt gemaakt in de vorm /gebruikers/{userId}	snaar
primaryKey	Primaire abonnementssleutel. Als deze niet is opgegeven tijdens de aanvraagsleutel, wordt automatisch gegenereerd.	snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 1
draagwijdte	Bereik zoals /products/{productId} of /apis of /apis/{apiId}.	tekenreeks (vereist)
secondaryKey	Secundaire abonnementssleutel. Als deze niet is opgegeven tijdens de aanvraagsleutel, wordt automatisch gegenereerd.	snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 1
staat	Initiële abonnementsstatus. Als er geen waarde is opgegeven, wordt het abonnement gemaakt met de status Verzonden. Mogelijke statussen zijn * actief – het abonnement is actief, * opgeschort – het abonnement wordt geblokkeerd en de abonnee kan geen API's van het product aanroepen, * ingediend – de abonnementsaanvraag is ingediend door de ontwikkelaar, maar is nog niet goedgekeurd of afgewezen, * geweigerd – de abonnementsaanvraag is geweigerd door een beheerder, * geannuleerd – het abonnement is geannuleerd door de ontwikkelaar of beheerder, * verlopen – het abonnement heeft de vervaldatum bereikt en is gedeactiveerd.	'actief' 'geannuleerd' 'verlopen' "afgewezen" "ingediend" "opgeschort"

Resourcedefinitie van ARM-sjabloon

Het resourcetype service/werkruimten/abonnementen kan worden geïmplementeerd met bewerkingen die zijn gericht op:

• Resourcegroepen - Zie opdrachten voor de implementatie van resourcegroepen

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een resource voor Microsoft.ApiManagement/service/werkruimten/abonnementen wilt maken, voegt u de volgende JSON toe aan uw sjabloon.

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

Eigenschapswaarden

Microsoft.ApiManagement/service/workspaces/subscriptions

Naam	Beschrijving	Waarde
apiVersion	De API-versie	'2024-06-01-preview'
naam	De resourcenaam	snaar Beperkingen: Maximale lengte = Patroon = ^[^*#&+:<>?]+$ (vereist)
Eigenschappen	Eigenschappen van abonnementscontract.	SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties
type	Het resourcetype	'Microsoft.ApiManagement/service/workspaces/subscriptions'

SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties

Naam	Beschrijving	Waarde
allowTracing	Bepaalt of tracering kan worden ingeschakeld	Bool
displayName	Abonnementsnaam.	snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 1 (vereist)
ownerId	Gebruiker (gebruikers-id-pad) voor wie het abonnement wordt gemaakt in de vorm /gebruikers/{userId}	snaar
primaryKey	Primaire abonnementssleutel. Als deze niet is opgegeven tijdens de aanvraagsleutel, wordt automatisch gegenereerd.	snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 1
draagwijdte	Bereik zoals /products/{productId} of /apis of /apis/{apiId}.	tekenreeks (vereist)
secondaryKey	Secundaire abonnementssleutel. Als deze niet is opgegeven tijdens de aanvraagsleutel, wordt automatisch gegenereerd.	snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 1
staat	Initiële abonnementsstatus. Als er geen waarde is opgegeven, wordt het abonnement gemaakt met de status Verzonden. Mogelijke statussen zijn * actief – het abonnement is actief, * opgeschort – het abonnement wordt geblokkeerd en de abonnee kan geen API's van het product aanroepen, * ingediend – de abonnementsaanvraag is ingediend door de ontwikkelaar, maar is nog niet goedgekeurd of afgewezen, * geweigerd – de abonnementsaanvraag is geweigerd door een beheerder, * geannuleerd – het abonnement is geannuleerd door de ontwikkelaar of beheerder, * verlopen – het abonnement heeft de vervaldatum bereikt en is gedeactiveerd.	'actief' 'geannuleerd' 'verlopen' "afgewezen" "ingediend" "opgeschort"

Resourcedefinitie van Terraform (AzAPI-provider)

Het resourcetype service/werkruimten/abonnementen kan worden geïmplementeerd met bewerkingen die zijn gericht op:

• resourcegroepen

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een resource voor Microsoft.ApiManagement/service/werkruimten/abonnementen wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.

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

Eigenschapswaarden

Microsoft.ApiManagement/service/workspaces/subscriptions

Naam	Beschrijving	Waarde
naam	De resourcenaam	snaar Beperkingen: Maximale lengte = Patroon = ^[^*#&+:<>?]+$ (vereist)
parent_id	De id van de resource die het bovenliggende item voor deze resource is.	Id voor resource van het type: service/werkruimten
Eigenschappen	Eigenschappen van abonnementscontract.	SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties
type	Het resourcetype	"Microsoft.ApiManagement/service/workspaces/subscriptions@2024-06-01-preview"

SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties

Naam	Beschrijving	Waarde
allowTracing	Bepaalt of tracering kan worden ingeschakeld	Bool
displayName	Abonnementsnaam.	snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 1 (vereist)
ownerId	Gebruiker (gebruikers-id-pad) voor wie het abonnement wordt gemaakt in de vorm /gebruikers/{userId}	snaar
primaryKey	Primaire abonnementssleutel. Als deze niet is opgegeven tijdens de aanvraagsleutel, wordt automatisch gegenereerd.	snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 1
draagwijdte	Bereik zoals /products/{productId} of /apis of /apis/{apiId}.	tekenreeks (vereist)
secondaryKey	Secundaire abonnementssleutel. Als deze niet is opgegeven tijdens de aanvraagsleutel, wordt automatisch gegenereerd.	snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 1
staat	Initiële abonnementsstatus. Als er geen waarde is opgegeven, wordt het abonnement gemaakt met de status Verzonden. Mogelijke statussen zijn * actief – het abonnement is actief, * opgeschort – het abonnement wordt geblokkeerd en de abonnee kan geen API's van het product aanroepen, * ingediend – de abonnementsaanvraag is ingediend door de ontwikkelaar, maar is nog niet goedgekeurd of afgewezen, * geweigerd – de abonnementsaanvraag is geweigerd door een beheerder, * geannuleerd – het abonnement is geannuleerd door de ontwikkelaar of beheerder, * verlopen – het abonnement heeft de vervaldatum bereikt en is gedeactiveerd.	'actief' 'geannuleerd' 'verlopen' "afgewezen" "ingediend" "opgeschort"