Class: Azure::StreamAnalytics::Mgmt::V2016_03_01::Models::OAuthBasedDataSourceProperties

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2016-03-01/generated/azure_mgmt_stream_analytics/models/oauth_based_data_source_properties.rb

Overview

The properties that are associated with data sources that use OAuth as their authentication model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#refresh_token ⇒ String

access token that can then be used to authenticate with the data source. A valid refresh token is currently only obtainable via the Azure Portal. It is recommended to put a dummy string value here when creating the data source and then going to the Azure Portal to authenticate the data source which will update this property with a valid refresh token. Required on PUT (CreateOrReplace) requests.

Returns:

  • (String) —

    A refresh token that can be used to obtain a valid



23
24
25
 
# File 'lib/2016-03-01/generated/azure_mgmt_stream_analytics/models/oauth_based_data_source_properties.rb', line 23

def refresh_token
  @refresh_token
end

#token_user_display_name ⇒ String

obtain the refresh token. Use this property to help remember which user was used to obtain the refresh token.

Returns:

  • (String) —

    The user display name of the user that was used to



33
34
35
 
# File 'lib/2016-03-01/generated/azure_mgmt_stream_analytics/models/oauth_based_data_source_properties.rb', line 33

def token_user_display_name
  @token_user_display_name
end

#token_user_principal_name ⇒ String

used to obtain the refresh token. Use this property to help remember which user was used to obtain the refresh token.

Returns:

  • (String) —

    The user principal name (UPN) of the user that was



28
29
30
 
# File 'lib/2016-03-01/generated/azure_mgmt_stream_analytics/models/oauth_based_data_source_properties.rb', line 28

def token_user_principal_name
  @token_user_principal_name
end

Class Method Details

.mapper ⇒ Object

Mapper for OAuthBasedDataSourceProperties class as Ruby Hash. This will be used for serialization/deserialization.



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/2016-03-01/generated/azure_mgmt_stream_analytics/models/oauth_based_data_source_properties.rb', line 40

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'OAuthBasedDataSourceProperties',
    type: {
      name: 'Composite',
      class_name: 'OAuthBasedDataSourceProperties',
      model_properties: {
        refresh_token: {
          client_side_validation: true,
          required: false,
          serialized_name: 'refreshToken',
          type: {
            name: 'String'
          }
        },
        token_user_principal_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'tokenUserPrincipalName',
          type: {
            name: 'String'
          }
        },
        token_user_display_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'tokenUserDisplayName',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end