Condividi tramite

Servizio Microsoft.ApiManagement/workspaces/subscriptions 2023-05-01-preview

  • Articolo

Definizione di risorsa Bicep

Il tipo di risorsa service/workspaces/subscriptions può essere distribuito con operazioni destinate:

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato di risorsa

Per creare una risorsa Microsoft.ApiManagement/service/workspaces/subscriptions, aggiungere il modello Bicep seguente.

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

Valori delle proprietà

service/workspaces/subscriptions

Nome Descrizione valore
name Nome della risorsa

Vedere come impostare nomi e tipi per le risorse figlio in Bicep.		 stringa (obbligatoria)
padre In Bicep è possibile specificare la risorsa padre per una risorsa figlio. È necessario aggiungere questa proprietà solo quando la risorsa figlio viene dichiarata all'esterno della risorsa padre.

Per altre informazioni, vedere Risorsa figlio esterna alla risorsa padre.		 Nome simbolico per la risorsa di tipo: aree di lavoro
properties Proprietà del contratto di sottoscrizione. SubscriptionCreateParameterPropertiesOrSubscriptionC...

SubscriptionCreateParameterPropertiesOrSubscriptionC...

Nome Descrizione Valore
allowTracing Determina se è possibile abilitare la traccia bool
displayName nome della sottoscrizione. stringa (obbligatoria)
ownerId Utente (percorso id utente) per cui viene creata la sottoscrizione in formato /users/{userId} string
primaryKey Chiave di sottoscrizione primaria. Se non specificato durante la chiave di richiesta verrà generato automaticamente. string
ambito Ambito come /products/{productId} o /apis o /apis/{apiId}. stringa (obbligatoria)
secondaryKey Chiave di sottoscrizione secondaria. Se non specificato durante la chiave di richiesta verrà generato automaticamente. string
state Stato della sottoscrizione iniziale. Se non viene specificato alcun valore, la sottoscrizione viene creata con stato Inviato. Gli stati possibili sono * attivi: la sottoscrizione è attiva, * sospesa - la sottoscrizione è bloccata e il sottoscrittore non può chiamare alcuna API del prodotto, * inviata - la richiesta di sottoscrizione è stata effettuata dallo sviluppatore, ma non è ancora stata approvata o rifiutata, * rifiutata - la richiesta di sottoscrizione è stata negata da un amministratore, * annullata - la sottoscrizione è stata annullata dallo sviluppatore o dall'amministratore, * scaduto: la sottoscrizione ha raggiunto la data di scadenza e è stata disattivata. 'active'
'annullata'
'scaduto'
'rifiutato'
'inviato'
'sospeso'

Definizione della risorsa modello di Resource Manager

Il tipo di risorsa service/workspaces/subscriptions può essere distribuito con operazioni destinate:

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato di risorsa

Per creare una risorsa Microsoft.ApiManagement/service/workspaces/subscriptions, aggiungere il codice JSON seguente al modello.

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

Valori delle proprietà

service/workspaces/subscriptions

Nome Descrizione Valore
tipo Tipo di risorsa 'Microsoft.ApiManagement/service/workspaces/subscriptions'
apiVersion Versione dell'API risorsa '2023-05-01-preview'
name Nome della risorsa

Vedere come impostare nomi e tipi per le risorse figlio nei modelli di RESOURCE JSON.		 stringa (obbligatoria)
properties Proprietà del contratto di sottoscrizione. SubscriptionCreateParameterPropertiesOrSubscriptionC...

SubscriptionCreateParameterPropertiesOrSubscriptionC...

Nome Descrizione Valore
allowTracing Determina se è possibile abilitare la traccia bool
displayName nome della sottoscrizione. stringa (obbligatoria)
ownerId Utente (percorso id utente) per cui viene creata la sottoscrizione in formato /users/{userId} string
primaryKey Chiave di sottoscrizione primaria. Se non specificato durante la chiave di richiesta verrà generato automaticamente. string
ambito Ambito come /products/{productId} o /apis o /apis/{apiId}. stringa (obbligatoria)
secondaryKey Chiave di sottoscrizione secondaria. Se non specificato durante la chiave di richiesta verrà generato automaticamente. string
state Stato della sottoscrizione iniziale. Se non viene specificato alcun valore, la sottoscrizione viene creata con stato Inviato. Gli stati possibili sono * attivi: la sottoscrizione è attiva, * sospesa - la sottoscrizione è bloccata e il sottoscrittore non può chiamare alcuna API del prodotto, * inviata - la richiesta di sottoscrizione è stata effettuata dallo sviluppatore, ma non è ancora stata approvata o rifiutata, * rifiutata - la richiesta di sottoscrizione è stata negata da un amministratore, * annullata - la sottoscrizione è stata annullata dallo sviluppatore o dall'amministratore, * scaduto: la sottoscrizione ha raggiunto la data di scadenza e è stata disattivata. 'active'
'annullata'
'scaduto'
'rifiutato'
'inviato'
'sospeso'

Definizione della risorsa Terraform (provider AzAPI)

Il tipo di risorsa service/workspaces/subscriptions può essere distribuito con operazioni destinate:

  • Gruppi di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato di risorsa

Per creare una risorsa Microsoft.ApiManagement/service/workspaces/subscriptions, aggiungere il codice Terraform seguente al modello.

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

Valori delle proprietà

service/workspaces/subscriptions

Nome Descrizione Valore
tipo Tipo di risorsa "Microsoft.ApiManagement/service/workspaces/subscriptions@2023-05-01-preview"
name Nome della risorsa stringa (obbligatoria)
parent_id ID della risorsa padre per questa risorsa. ID per la risorsa di tipo: aree di lavoro
properties Proprietà del contratto di sottoscrizione. SubscriptionCreateParameterPropertiesOrSubscriptionC...

SubscriptionCreateParameterPropertiesOrSubscriptionC...

Nome Descrizione Valore
allowTracing Determina se è possibile abilitare la traccia bool
displayName nome della sottoscrizione. stringa (obbligatoria)
ownerId Utente (percorso id utente) per cui viene creata la sottoscrizione in formato /users/{userId} string
primaryKey Chiave di sottoscrizione primaria. Se non specificato durante la chiave di richiesta verrà generato automaticamente. string
ambito Ambito come /products/{productId} o /apis o /apis/{apiId}. stringa (obbligatoria)
secondaryKey Chiave di sottoscrizione secondaria. Se non specificato durante la chiave di richiesta verrà generato automaticamente. string
state Stato della sottoscrizione iniziale. Se non viene specificato alcun valore, la sottoscrizione viene creata con stato Inviato. Gli stati possibili sono * attivi: la sottoscrizione è attiva, * sospesa - la sottoscrizione è bloccata e il sottoscrittore non può chiamare alcuna API del prodotto, * inviata - la richiesta di sottoscrizione è stata effettuata dallo sviluppatore, ma non è ancora stata approvata o rifiutata, * rifiutata - la richiesta di sottoscrizione è stata negata da un amministratore, * annullata - la sottoscrizione è stata annullata dallo sviluppatore o dall'amministratore, * scaduto: la sottoscrizione ha raggiunto la data di scadenza e è stata disattivata. "attivo"
"annullata"
"scaduto"
"rifiutato"
"inviato"
"sospeso"