Microsoft.ApiManagement service/subscriptions 2024-06-01-preview
- najnowsze
- 2024-06-01-preview
- 2024-05-01
- 2023-09-01-preview
- 2023-05-01-preview
- 2023-03-01-preview
- 2022-09-01-preview
- 2022-08-01
- 2022-04-01-preview
- 2021-12-01-preview
- 2021-08-01
- 2021-04-01-preview
- 2021-01-01-preview
- 2020-12-01
- 2020-06-01-preview
- 2019-12-01
- 2019-12-01-preview
- 2019-01-01
- 2018-06-01-preview
- 2018-01-01
- 2017-03-01
- 2016-10-10
- 2016-07-07
Definicja zasobu Bicep
Typ zasobu usługi/subskrypcji można wdrożyć przy użyciu operacji docelowych:
- grupy zasobów — zobacz polecenia wdrażania grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.
Format zasobu
Aby utworzyć zasób Microsoft.ApiManagement/service/subscriptions, dodaj następujący kod Bicep do szablonu.
resource symbolicname 'Microsoft.ApiManagement/service/subscriptions@2024-06-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
allowTracing: bool
displayName: 'string'
ownerId: 'string'
primaryKey: 'string'
scope: 'string'
secondaryKey: 'string'
state: 'string'
}
}
Wartości właściwości
Microsoft.ApiManagement/service/subscriptions
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa | Nazwa zasobu | struna Ograniczenia: Maksymalna długość = 256 Wzorzec = ^[^*#&+:<>?]+$ (wymagane) |
| rodzic | W Bicep można określić zasób nadrzędny dla zasobu podrzędnego. Tę właściwość należy dodać tylko wtedy, gdy zasób podrzędny jest zadeklarowany poza zasobem nadrzędnym. Aby uzyskać więcej informacji, zobacz Zasób podrzędny poza zasobem nadrzędnym. |
Nazwa symboliczna zasobu typu: usługi |
| Właściwości | Właściwości kontraktu subskrypcji. | SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties |
SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| allowTracing | Określa, czy można włączyć śledzenie | Bool |
| displayName | Nazwa subskrypcji. | struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 100 (wymagana) |
| ownerId | Użytkownik (ścieżka identyfikatora użytkownika), dla którego subskrypcja jest tworzona w postaci /users/{userId} | struna |
| primaryKey | Podstawowy klucz subskrypcji. Jeśli klucz żądania nie zostanie określony, zostanie wygenerowany automatycznie. | struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 256 |
| zakres | Zakres, taki jak /products/{productId} lub /apis lub /apis/{apiId}. | ciąg (wymagany) |
| secondaryKey | Pomocniczy klucz subskrypcji. Jeśli klucz żądania nie zostanie określony, zostanie wygenerowany automatycznie. | struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 256 |
| stan | Początkowy stan subskrypcji. Jeśli żadna wartość nie zostanie określona, subskrypcja zostanie utworzona ze stanem Przesłano. Możliwe stany są * aktywne — subskrypcja jest aktywna, * zawieszona — subskrypcja jest zablokowana, a subskrybent nie może wywołać żadnych interfejsów API produktu, * przesłane — żądanie subskrypcji zostało złożone przez dewelopera, ale nie zostało jeszcze zatwierdzone lub odrzucone, * odrzucono — żądanie subskrypcji zostało odrzucone przez administratora, * anulowane — subskrypcja została anulowana przez dewelopera lub administratora, * wygasła — subskrypcja osiągnęła datę wygaśnięcia i została zdezaktywowana. | "aktywny" "Anulowano" "wygasł" "odrzucone" "przesłane" "zawieszone" |
Definicja zasobu szablonu usługi ARM
Typ zasobu usługi/subskrypcji można wdrożyć przy użyciu operacji docelowych:
- grupy zasobów — zobacz polecenia wdrażania grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.
Format zasobu
Aby utworzyć zasób Microsoft.ApiManagement/service/subscriptions, dodaj następujący kod JSON do szablonu.
{
"type": "Microsoft.ApiManagement/service/subscriptions",
"apiVersion": "2024-06-01-preview",
"name": "string",
"properties": {
"allowTracing": "bool",
"displayName": "string",
"ownerId": "string",
"primaryKey": "string",
"scope": "string",
"secondaryKey": "string",
"state": "string"
}
}
Wartości właściwości
Microsoft.ApiManagement/service/subscriptions
| Nazwa | Opis | Wartość |
|---|---|---|
| apiVersion | Wersja interfejsu API | "2024-06-01-preview" |
| nazwa | Nazwa zasobu | struna Ograniczenia: Maksymalna długość = 256 Wzorzec = ^[^*#&+:<>?]+$ (wymagane) |
| Właściwości | Właściwości kontraktu subskrypcji. | SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties |
| typ | Typ zasobu | "Microsoft.ApiManagement/service/subscriptions" |
SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| allowTracing | Określa, czy można włączyć śledzenie | Bool |
| displayName | Nazwa subskrypcji. | struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 100 (wymagana) |
| ownerId | Użytkownik (ścieżka identyfikatora użytkownika), dla którego subskrypcja jest tworzona w postaci /users/{userId} | struna |
| primaryKey | Podstawowy klucz subskrypcji. Jeśli klucz żądania nie zostanie określony, zostanie wygenerowany automatycznie. | struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 256 |
| zakres | Zakres, taki jak /products/{productId} lub /apis lub /apis/{apiId}. | ciąg (wymagany) |
| secondaryKey | Pomocniczy klucz subskrypcji. Jeśli klucz żądania nie zostanie określony, zostanie wygenerowany automatycznie. | struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 256 |
| stan | Początkowy stan subskrypcji. Jeśli żadna wartość nie zostanie określona, subskrypcja zostanie utworzona ze stanem Przesłano. Możliwe stany są * aktywne — subskrypcja jest aktywna, * zawieszona — subskrypcja jest zablokowana, a subskrybent nie może wywołać żadnych interfejsów API produktu, * przesłane — żądanie subskrypcji zostało złożone przez dewelopera, ale nie zostało jeszcze zatwierdzone lub odrzucone, * odrzucono — żądanie subskrypcji zostało odrzucone przez administratora, * anulowane — subskrypcja została anulowana przez dewelopera lub administratora, * wygasła — subskrypcja osiągnęła datę wygaśnięcia i została zdezaktywowana. | "aktywny" "Anulowano" "wygasł" "odrzucone" "przesłane" "zawieszone" |
Definicja zasobu narzędzia Terraform (dostawcy AzAPI)
Typ zasobu usługi/subskrypcji można wdrożyć przy użyciu operacji docelowych:
- grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.
Format zasobu
Aby utworzyć zasób Microsoft.ApiManagement/service/subscriptions, dodaj następujący program Terraform do szablonu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/subscriptions@2024-06-01-preview"
name = "string"
body = jsonencode({
properties = {
allowTracing = bool
displayName = "string"
ownerId = "string"
primaryKey = "string"
scope = "string"
secondaryKey = "string"
state = "string"
}
})
}
Wartości właściwości
Microsoft.ApiManagement/service/subscriptions
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa | Nazwa zasobu | struna Ograniczenia: Maksymalna długość = 256 Wzorzec = ^[^*#&+:<>?]+$ (wymagane) |
| parent_id | Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. | Identyfikator zasobu typu: usługi |
| Właściwości | Właściwości kontraktu subskrypcji. | SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties |
| typ | Typ zasobu | "Microsoft.ApiManagement/service/subscriptions@2024-06-01-preview" |
SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| allowTracing | Określa, czy można włączyć śledzenie | Bool |
| displayName | Nazwa subskrypcji. | struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 100 (wymagana) |
| ownerId | Użytkownik (ścieżka identyfikatora użytkownika), dla którego subskrypcja jest tworzona w postaci /users/{userId} | struna |
| primaryKey | Podstawowy klucz subskrypcji. Jeśli klucz żądania nie zostanie określony, zostanie wygenerowany automatycznie. | struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 256 |
| zakres | Zakres, taki jak /products/{productId} lub /apis lub /apis/{apiId}. | ciąg (wymagany) |
| secondaryKey | Pomocniczy klucz subskrypcji. Jeśli klucz żądania nie zostanie określony, zostanie wygenerowany automatycznie. | struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 256 |
| stan | Początkowy stan subskrypcji. Jeśli żadna wartość nie zostanie określona, subskrypcja zostanie utworzona ze stanem Przesłano. Możliwe stany są * aktywne — subskrypcja jest aktywna, * zawieszona — subskrypcja jest zablokowana, a subskrybent nie może wywołać żadnych interfejsów API produktu, * przesłane — żądanie subskrypcji zostało złożone przez dewelopera, ale nie zostało jeszcze zatwierdzone lub odrzucone, * odrzucono — żądanie subskrypcji zostało odrzucone przez administratora, * anulowane — subskrypcja została anulowana przez dewelopera lub administratora, * wygasła — subskrypcja osiągnęła datę wygaśnięcia i została zdezaktywowana. | "aktywny" "Anulowano" "wygasł" "odrzucone" "przesłane" "zawieszone" |