Subscription interface
Rozhraní představující předplatné
Metody
Podrobnosti metody
createOrUpdate(string, string, string, SubscriptionCreateParameters, SubscriptionCreateOrUpdateOptionalParams)
Vytvoří nebo aktualizuje předplatné zadaného uživatele na zadaný produkt.
function createOrUpdate(resourceGroupName: string, serviceName: string, sid: string, parameters: SubscriptionCreateParameters, options?: SubscriptionCreateOrUpdateOptionalParams): Promise<SubscriptionCreateOrUpdateResponse>Parametry
- resourceGroupName
-
string
Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
- serviceName
-
string
Název služby API Management.
- sid
-
string
Identifikátor entity předplatného Entita představuje přidružení mezi uživatelem a produktem ve službě API Management.
- parameters
- SubscriptionCreateParameters
Vytvořte parametry.
Parametry možností.
Návraty
Promise<SubscriptionCreateOrUpdateResponse>
delete(string, string, string, string, SubscriptionDeleteOptionalParams)
Odstraní zadané předplatné.
function delete(resourceGroupName: string, serviceName: string, sid: string, ifMatch: string, options?: SubscriptionDeleteOptionalParams): Promise<void>Parametry
- resourceGroupName
-
string
Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
- serviceName
-
string
Název služby API Management.
- sid
-
string
Identifikátor entity předplatného Entita představuje přidružení mezi uživatelem a produktem ve službě API Management.
- ifMatch
-
string
ETag of the Entity. Značka ETag by měla odpovídat aktuálnímu stavu entity z odpovědi hlavičky požadavku GET, nebo by měla být * pro nepodmíněnou aktualizaci.
- options
- SubscriptionDeleteOptionalParams
Parametry možností.
Návraty
Promise<void>
get(string, string, string, SubscriptionGetOptionalParams)
Získá zadanou entitu Předplatné.
function get(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionGetOptionalParams): Promise<SubscriptionGetResponse>Parametry
- resourceGroupName
-
string
Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
- serviceName
-
string
Název služby API Management.
- sid
-
string
Identifikátor entity předplatného Entita představuje přidružení mezi uživatelem a produktem ve službě API Management.
- options
- SubscriptionGetOptionalParams
Parametry možností.
Návraty
Promise<SubscriptionGetResponse>
getEntityTag(string, string, string, SubscriptionGetEntityTagOptionalParams)
Získá verzi stavu entity (Etag) předplatného apimanagement určeného jeho identifikátorem.
function getEntityTag(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionGetEntityTagOptionalParams): Promise<SubscriptionGetEntityTagHeaders>Parametry
- resourceGroupName
-
string
Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
- serviceName
-
string
Název služby API Management.
- sid
-
string
Identifikátor entity předplatného Entita představuje přidružení mezi uživatelem a produktem ve službě API Management.
Parametry možností.
Návraty
Promise<SubscriptionGetEntityTagHeaders>
list(string, string, SubscriptionListOptionalParams)
Zobrazí seznam všech předplatných instance služby API Management.
function list(resourceGroupName: string, serviceName: string, options?: SubscriptionListOptionalParams): PagedAsyncIterableIterator<SubscriptionContract, SubscriptionContract[], PageSettings>Parametry
- resourceGroupName
-
string
Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
- serviceName
-
string
Název služby API Management.
- options
- SubscriptionListOptionalParams
Parametry možností.
Návraty
listSecrets(string, string, string, SubscriptionListSecretsOptionalParams)
Získá zadané klíče předplatného.
function listSecrets(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionListSecretsOptionalParams): Promise<SubscriptionListSecretsResponse>Parametry
- resourceGroupName
-
string
Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
- serviceName
-
string
Název služby API Management.
- sid
-
string
Identifikátor entity předplatného Entita představuje přidružení mezi uživatelem a produktem ve službě API Management.
Parametry možností.
Návraty
Promise<SubscriptionListSecretsResponse>
regeneratePrimaryKey(string, string, string, SubscriptionRegeneratePrimaryKeyOptionalParams)
Znovu vygeneruje primární klíč stávajícího předplatného instance služby API Management.
function regeneratePrimaryKey(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionRegeneratePrimaryKeyOptionalParams): Promise<void>Parametry
- resourceGroupName
-
string
Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
- serviceName
-
string
Název služby API Management.
- sid
-
string
Identifikátor entity předplatného Entita představuje přidružení mezi uživatelem a produktem ve službě API Management.
Parametry možností.
Návraty
Promise<void>
regenerateSecondaryKey(string, string, string, SubscriptionRegenerateSecondaryKeyOptionalParams)
Znovu vygeneruje sekundární klíč stávajícího předplatného instance služby API Management.
function regenerateSecondaryKey(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionRegenerateSecondaryKeyOptionalParams): Promise<void>Parametry
- resourceGroupName
-
string
Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
- serviceName
-
string
Název služby API Management.
- sid
-
string
Identifikátor entity předplatného Entita představuje přidružení mezi uživatelem a produktem ve službě API Management.
Parametry možností.
Návraty
Promise<void>
update(string, string, string, string, SubscriptionUpdateParameters, SubscriptionUpdateOptionalParams)
Aktualizuje podrobnosti předplatného určeného jeho identifikátorem.
function update(resourceGroupName: string, serviceName: string, sid: string, ifMatch: string, parameters: SubscriptionUpdateParameters, options?: SubscriptionUpdateOptionalParams): Promise<SubscriptionUpdateResponse>Parametry
- resourceGroupName
-
string
Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
- serviceName
-
string
Název služby API Management.
- sid
-
string
Identifikátor entity předplatného Entita představuje přidružení mezi uživatelem a produktem ve službě API Management.
- ifMatch
-
string
ETag of the Entity. Značka ETag by měla odpovídat aktuálnímu stavu entity z odpovědi hlavičky požadavku GET, nebo by měla být * pro nepodmíněnou aktualizaci.
- parameters
- SubscriptionUpdateParameters
Aktualizujte parametry.
- options
- SubscriptionUpdateOptionalParams
Parametry možností.
Návraty
Promise<SubscriptionUpdateResponse>